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 core::convert::Infallible;
25 use bitcoin::hashes::Hash;
26 use crate::c_types::*;
29 use lightning::chain::channelmonitor::ChannelMonitorUpdate as nativeChannelMonitorUpdateImport;
30 pub(crate) type nativeChannelMonitorUpdate = nativeChannelMonitorUpdateImport;
32 /// An update generated by the underlying Channel itself which contains some new information the
33 /// ChannelMonitor should be made aware of.
36 pub struct ChannelMonitorUpdate {
37 /// A pointer to the opaque Rust object.
39 /// Nearly everywhere, inner must be non-null, however in places where
40 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
41 pub inner: *mut nativeChannelMonitorUpdate,
42 /// Indicates that this is the only struct which contains the same pointer.
44 /// Rust functions which take ownership of an object provided via an argument require
45 /// this to be true and invalidate the object pointed to by inner.
49 impl Drop for ChannelMonitorUpdate {
51 if self.is_owned && !<*mut nativeChannelMonitorUpdate>::is_null(self.inner) {
52 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
56 /// Frees any resources used by the ChannelMonitorUpdate, if is_owned is set and inner is non-NULL.
58 pub extern "C" fn ChannelMonitorUpdate_free(this_obj: ChannelMonitorUpdate) { }
60 /// Used only if an object of this type is returned as a trait impl by a method
61 pub(crate) extern "C" fn ChannelMonitorUpdate_free_void(this_ptr: *mut c_void) {
62 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelMonitorUpdate); }
65 impl ChannelMonitorUpdate {
66 pub(crate) fn get_native_ref(&self) -> &'static nativeChannelMonitorUpdate {
67 unsafe { &*ObjOps::untweak_ptr(self.inner) }
69 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelMonitorUpdate {
70 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
72 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
73 pub(crate) fn take_inner(mut self) -> *mut nativeChannelMonitorUpdate {
74 assert!(self.is_owned);
75 let ret = ObjOps::untweak_ptr(self.inner);
76 self.inner = std::ptr::null_mut();
80 /// The sequence number of this update. Updates *must* be replayed in-order according to this
81 /// sequence number (and updates may panic if they are not). The update_id values are strictly
82 /// increasing and increase by one for each new update, with one exception specified below.
84 /// This sequence number is also used to track up to which points updates which returned
85 /// ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
86 /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
88 /// The only instance where update_id values are not strictly increasing is the case where we
89 /// allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
90 /// its docs for more details.
92 pub extern "C" fn ChannelMonitorUpdate_get_update_id(this_ptr: &ChannelMonitorUpdate) -> u64 {
93 let mut inner_val = &mut this_ptr.get_native_mut_ref().update_id;
96 /// The sequence number of this update. Updates *must* be replayed in-order according to this
97 /// sequence number (and updates may panic if they are not). The update_id values are strictly
98 /// increasing and increase by one for each new update, with one exception specified below.
100 /// This sequence number is also used to track up to which points updates which returned
101 /// ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
102 /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
104 /// The only instance where update_id values are not strictly increasing is the case where we
105 /// allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
106 /// its docs for more details.
108 pub extern "C" fn ChannelMonitorUpdate_set_update_id(this_ptr: &mut ChannelMonitorUpdate, mut val: u64) {
109 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.update_id = val;
111 impl Clone for ChannelMonitorUpdate {
112 fn clone(&self) -> Self {
114 inner: if <*mut nativeChannelMonitorUpdate>::is_null(self.inner) { std::ptr::null_mut() } else {
115 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
121 /// Used only if an object of this type is returned as a trait impl by a method
122 pub(crate) extern "C" fn ChannelMonitorUpdate_clone_void(this_ptr: *const c_void) -> *mut c_void {
123 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeChannelMonitorUpdate)).clone() })) as *mut c_void
126 /// Creates a copy of the ChannelMonitorUpdate
127 pub extern "C" fn ChannelMonitorUpdate_clone(orig: &ChannelMonitorUpdate) -> ChannelMonitorUpdate {
131 /// (1) a channel has been force closed and
132 /// (2) we receive a preimage from a forward link that allows us to spend an HTLC output on
133 /// this channel's (the backward link's) broadcasted commitment transaction
134 /// then we allow the `ChannelManager` to send a `ChannelMonitorUpdate` with this update ID,
135 /// with the update providing said payment preimage. No other update types are allowed after
139 pub static CLOSED_CHANNEL_UPDATE_ID: u64 = lightning::chain::channelmonitor::CLOSED_CHANNEL_UPDATE_ID;
141 /// Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read
142 pub extern "C" fn ChannelMonitorUpdate_write(obj: &ChannelMonitorUpdate) -> crate::c_types::derived::CVec_u8Z {
143 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
146 pub(crate) extern "C" fn ChannelMonitorUpdate_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
147 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelMonitorUpdate) })
150 /// Read a ChannelMonitorUpdate from a byte array, created by ChannelMonitorUpdate_write
151 pub extern "C" fn ChannelMonitorUpdate_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_ChannelMonitorUpdateDecodeErrorZ {
152 let res: Result<lightning::chain::channelmonitor::ChannelMonitorUpdate, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
153 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::chain::channelmonitor::ChannelMonitorUpdate { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
157 use lightning::chain::channelmonitor::MonitorUpdateError as nativeMonitorUpdateErrorImport;
158 pub(crate) type nativeMonitorUpdateError = nativeMonitorUpdateErrorImport;
160 /// General Err type for ChannelMonitor actions. Generally, this implies that the data provided is
161 /// inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::update_monitor this
162 /// means you tried to update a monitor for a different channel or the ChannelMonitorUpdate was
164 /// Contains a developer-readable error message.
167 pub struct MonitorUpdateError {
168 /// A pointer to the opaque Rust object.
170 /// Nearly everywhere, inner must be non-null, however in places where
171 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
172 pub inner: *mut nativeMonitorUpdateError,
173 /// Indicates that this is the only struct which contains the same pointer.
175 /// Rust functions which take ownership of an object provided via an argument require
176 /// this to be true and invalidate the object pointed to by inner.
180 impl Drop for MonitorUpdateError {
182 if self.is_owned && !<*mut nativeMonitorUpdateError>::is_null(self.inner) {
183 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
187 /// Frees any resources used by the MonitorUpdateError, if is_owned is set and inner is non-NULL.
189 pub extern "C" fn MonitorUpdateError_free(this_obj: MonitorUpdateError) { }
191 /// Used only if an object of this type is returned as a trait impl by a method
192 pub(crate) extern "C" fn MonitorUpdateError_free_void(this_ptr: *mut c_void) {
193 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeMonitorUpdateError); }
196 impl MonitorUpdateError {
197 pub(crate) fn get_native_ref(&self) -> &'static nativeMonitorUpdateError {
198 unsafe { &*ObjOps::untweak_ptr(self.inner) }
200 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeMonitorUpdateError {
201 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
203 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
204 pub(crate) fn take_inner(mut self) -> *mut nativeMonitorUpdateError {
205 assert!(self.is_owned);
206 let ret = ObjOps::untweak_ptr(self.inner);
207 self.inner = std::ptr::null_mut();
212 pub extern "C" fn MonitorUpdateError_get_a(this_ptr: &MonitorUpdateError) -> crate::c_types::Str {
213 let mut inner_val = &mut this_ptr.get_native_mut_ref().0;
217 pub extern "C" fn MonitorUpdateError_set_a(this_ptr: &mut MonitorUpdateError, mut val: crate::c_types::Str) {
218 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.0 = val.into_str();
220 /// Constructs a new MonitorUpdateError given each field
223 pub extern "C" fn MonitorUpdateError_new(mut a_arg: crate::c_types::Str) -> MonitorUpdateError {
224 MonitorUpdateError { inner: ObjOps::heap_alloc(lightning::chain::channelmonitor::MonitorUpdateError (
228 impl Clone for MonitorUpdateError {
229 fn clone(&self) -> Self {
231 inner: if <*mut nativeMonitorUpdateError>::is_null(self.inner) { std::ptr::null_mut() } else {
232 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
238 /// Used only if an object of this type is returned as a trait impl by a method
239 pub(crate) extern "C" fn MonitorUpdateError_clone_void(this_ptr: *const c_void) -> *mut c_void {
240 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeMonitorUpdateError)).clone() })) as *mut c_void
243 /// Creates a copy of the MonitorUpdateError
244 pub extern "C" fn MonitorUpdateError_clone(orig: &MonitorUpdateError) -> MonitorUpdateError {
247 /// An event to be processed by the ChannelManager.
251 pub enum MonitorEvent {
252 /// A monitor event containing an HTLCUpdate.
253 HTLCEvent(crate::lightning::chain::channelmonitor::HTLCUpdate),
254 /// A monitor event that the Channel's commitment transaction was confirmed.
255 CommitmentTxConfirmed(crate::lightning::chain::transaction::OutPoint),
256 /// Indicates a [`ChannelMonitor`] update has completed. See
257 /// [`ChannelMonitorUpdateErr::TemporaryFailure`] for more information on how this is used.
259 /// [`ChannelMonitorUpdateErr::TemporaryFailure`]: super::ChannelMonitorUpdateErr::TemporaryFailure
261 /// The funding outpoint of the [`ChannelMonitor`] that was updated
262 funding_txo: crate::lightning::chain::transaction::OutPoint,
263 /// The Update ID from [`ChannelMonitorUpdate::update_id`] which was applied or
264 /// [`ChannelMonitor::get_latest_update_id`].
266 /// Note that this should only be set to a given update's ID if all previous updates for the
267 /// same [`ChannelMonitor`] have been applied and persisted.
268 monitor_update_id: u64,
270 /// Indicates a [`ChannelMonitor`] update has failed. See
271 /// [`ChannelMonitorUpdateErr::PermanentFailure`] for more information on how this is used.
273 /// [`ChannelMonitorUpdateErr::PermanentFailure`]: super::ChannelMonitorUpdateErr::PermanentFailure
274 UpdateFailed(crate::lightning::chain::transaction::OutPoint),
276 use lightning::chain::channelmonitor::MonitorEvent as nativeMonitorEvent;
279 pub(crate) fn to_native(&self) -> nativeMonitorEvent {
281 MonitorEvent::HTLCEvent (ref a, ) => {
282 let mut a_nonref = (*a).clone();
283 nativeMonitorEvent::HTLCEvent (
284 *unsafe { Box::from_raw(a_nonref.take_inner()) },
287 MonitorEvent::CommitmentTxConfirmed (ref a, ) => {
288 let mut a_nonref = (*a).clone();
289 nativeMonitorEvent::CommitmentTxConfirmed (
290 *unsafe { Box::from_raw(a_nonref.take_inner()) },
293 MonitorEvent::UpdateCompleted {ref funding_txo, ref monitor_update_id, } => {
294 let mut funding_txo_nonref = (*funding_txo).clone();
295 let mut monitor_update_id_nonref = (*monitor_update_id).clone();
296 nativeMonitorEvent::UpdateCompleted {
297 funding_txo: *unsafe { Box::from_raw(funding_txo_nonref.take_inner()) },
298 monitor_update_id: monitor_update_id_nonref,
301 MonitorEvent::UpdateFailed (ref a, ) => {
302 let mut a_nonref = (*a).clone();
303 nativeMonitorEvent::UpdateFailed (
304 *unsafe { Box::from_raw(a_nonref.take_inner()) },
310 pub(crate) fn into_native(self) -> nativeMonitorEvent {
312 MonitorEvent::HTLCEvent (mut a, ) => {
313 nativeMonitorEvent::HTLCEvent (
314 *unsafe { Box::from_raw(a.take_inner()) },
317 MonitorEvent::CommitmentTxConfirmed (mut a, ) => {
318 nativeMonitorEvent::CommitmentTxConfirmed (
319 *unsafe { Box::from_raw(a.take_inner()) },
322 MonitorEvent::UpdateCompleted {mut funding_txo, mut monitor_update_id, } => {
323 nativeMonitorEvent::UpdateCompleted {
324 funding_txo: *unsafe { Box::from_raw(funding_txo.take_inner()) },
325 monitor_update_id: monitor_update_id,
328 MonitorEvent::UpdateFailed (mut a, ) => {
329 nativeMonitorEvent::UpdateFailed (
330 *unsafe { Box::from_raw(a.take_inner()) },
336 pub(crate) fn from_native(native: &nativeMonitorEvent) -> Self {
338 nativeMonitorEvent::HTLCEvent (ref a, ) => {
339 let mut a_nonref = (*a).clone();
340 MonitorEvent::HTLCEvent (
341 crate::lightning::chain::channelmonitor::HTLCUpdate { inner: ObjOps::heap_alloc(a_nonref), is_owned: true },
344 nativeMonitorEvent::CommitmentTxConfirmed (ref a, ) => {
345 let mut a_nonref = (*a).clone();
346 MonitorEvent::CommitmentTxConfirmed (
347 crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(a_nonref), is_owned: true },
350 nativeMonitorEvent::UpdateCompleted {ref funding_txo, ref monitor_update_id, } => {
351 let mut funding_txo_nonref = (*funding_txo).clone();
352 let mut monitor_update_id_nonref = (*monitor_update_id).clone();
353 MonitorEvent::UpdateCompleted {
354 funding_txo: crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(funding_txo_nonref), is_owned: true },
355 monitor_update_id: monitor_update_id_nonref,
358 nativeMonitorEvent::UpdateFailed (ref a, ) => {
359 let mut a_nonref = (*a).clone();
360 MonitorEvent::UpdateFailed (
361 crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(a_nonref), is_owned: true },
367 pub(crate) fn native_into(native: nativeMonitorEvent) -> Self {
369 nativeMonitorEvent::HTLCEvent (mut a, ) => {
370 MonitorEvent::HTLCEvent (
371 crate::lightning::chain::channelmonitor::HTLCUpdate { inner: ObjOps::heap_alloc(a), is_owned: true },
374 nativeMonitorEvent::CommitmentTxConfirmed (mut a, ) => {
375 MonitorEvent::CommitmentTxConfirmed (
376 crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(a), is_owned: true },
379 nativeMonitorEvent::UpdateCompleted {mut funding_txo, mut monitor_update_id, } => {
380 MonitorEvent::UpdateCompleted {
381 funding_txo: crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(funding_txo), is_owned: true },
382 monitor_update_id: monitor_update_id,
385 nativeMonitorEvent::UpdateFailed (mut a, ) => {
386 MonitorEvent::UpdateFailed (
387 crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(a), is_owned: true },
393 /// Frees any resources used by the MonitorEvent
395 pub extern "C" fn MonitorEvent_free(this_ptr: MonitorEvent) { }
396 /// Creates a copy of the MonitorEvent
398 pub extern "C" fn MonitorEvent_clone(orig: &MonitorEvent) -> MonitorEvent {
402 /// Utility method to constructs a new HTLCEvent-variant MonitorEvent
403 pub extern "C" fn MonitorEvent_htlcevent(a: crate::lightning::chain::channelmonitor::HTLCUpdate) -> MonitorEvent {
404 MonitorEvent::HTLCEvent(a, )
407 /// Utility method to constructs a new CommitmentTxConfirmed-variant MonitorEvent
408 pub extern "C" fn MonitorEvent_commitment_tx_confirmed(a: crate::lightning::chain::transaction::OutPoint) -> MonitorEvent {
409 MonitorEvent::CommitmentTxConfirmed(a, )
412 /// Utility method to constructs a new UpdateCompleted-variant MonitorEvent
413 pub extern "C" fn MonitorEvent_update_completed(funding_txo: crate::lightning::chain::transaction::OutPoint, monitor_update_id: u64) -> MonitorEvent {
414 MonitorEvent::UpdateCompleted {
420 /// Utility method to constructs a new UpdateFailed-variant MonitorEvent
421 pub extern "C" fn MonitorEvent_update_failed(a: crate::lightning::chain::transaction::OutPoint) -> MonitorEvent {
422 MonitorEvent::UpdateFailed(a, )
425 /// Serialize the MonitorEvent object into a byte array which can be read by MonitorEvent_read
426 pub extern "C" fn MonitorEvent_write(obj: &MonitorEvent) -> crate::c_types::derived::CVec_u8Z {
427 crate::c_types::serialize_obj(&unsafe { &*obj }.to_native())
430 /// Read a MonitorEvent from a byte array, created by MonitorEvent_write
431 pub extern "C" fn MonitorEvent_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_COption_MonitorEventZDecodeErrorZ {
432 let res: Result<Option<lightning::chain::channelmonitor::MonitorEvent>, lightning::ln::msgs::DecodeError> = crate::c_types::maybe_deserialize_obj(ser);
433 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { let mut local_res_0 = if o.is_none() { crate::c_types::derived::COption_MonitorEventZ::None } else { crate::c_types::derived::COption_MonitorEventZ::Some( { crate::lightning::chain::channelmonitor::MonitorEvent::native_into(o.unwrap()) }) }; local_res_0 }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
437 use lightning::chain::channelmonitor::HTLCUpdate as nativeHTLCUpdateImport;
438 pub(crate) type nativeHTLCUpdate = nativeHTLCUpdateImport;
440 /// Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
441 /// chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
442 /// preimage claim backward will lead to loss of funds.
445 pub struct HTLCUpdate {
446 /// A pointer to the opaque Rust object.
448 /// Nearly everywhere, inner must be non-null, however in places where
449 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
450 pub inner: *mut nativeHTLCUpdate,
451 /// Indicates that this is the only struct which contains the same pointer.
453 /// Rust functions which take ownership of an object provided via an argument require
454 /// this to be true and invalidate the object pointed to by inner.
458 impl Drop for HTLCUpdate {
460 if self.is_owned && !<*mut nativeHTLCUpdate>::is_null(self.inner) {
461 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
465 /// Frees any resources used by the HTLCUpdate, if is_owned is set and inner is non-NULL.
467 pub extern "C" fn HTLCUpdate_free(this_obj: HTLCUpdate) { }
469 /// Used only if an object of this type is returned as a trait impl by a method
470 pub(crate) extern "C" fn HTLCUpdate_free_void(this_ptr: *mut c_void) {
471 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeHTLCUpdate); }
475 pub(crate) fn get_native_ref(&self) -> &'static nativeHTLCUpdate {
476 unsafe { &*ObjOps::untweak_ptr(self.inner) }
478 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeHTLCUpdate {
479 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
481 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
482 pub(crate) fn take_inner(mut self) -> *mut nativeHTLCUpdate {
483 assert!(self.is_owned);
484 let ret = ObjOps::untweak_ptr(self.inner);
485 self.inner = std::ptr::null_mut();
489 impl Clone for HTLCUpdate {
490 fn clone(&self) -> Self {
492 inner: if <*mut nativeHTLCUpdate>::is_null(self.inner) { std::ptr::null_mut() } else {
493 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
499 /// Used only if an object of this type is returned as a trait impl by a method
500 pub(crate) extern "C" fn HTLCUpdate_clone_void(this_ptr: *const c_void) -> *mut c_void {
501 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeHTLCUpdate)).clone() })) as *mut c_void
504 /// Creates a copy of the HTLCUpdate
505 pub extern "C" fn HTLCUpdate_clone(orig: &HTLCUpdate) -> HTLCUpdate {
509 /// Serialize the HTLCUpdate object into a byte array which can be read by HTLCUpdate_read
510 pub extern "C" fn HTLCUpdate_write(obj: &HTLCUpdate) -> crate::c_types::derived::CVec_u8Z {
511 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
514 pub(crate) extern "C" fn HTLCUpdate_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
515 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeHTLCUpdate) })
518 /// Read a HTLCUpdate from a byte array, created by HTLCUpdate_write
519 pub extern "C" fn HTLCUpdate_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_HTLCUpdateDecodeErrorZ {
520 let res: Result<lightning::chain::channelmonitor::HTLCUpdate, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
521 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::chain::channelmonitor::HTLCUpdate { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };
524 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding
525 /// inbound HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us
528 /// Note that this is a library-wide security assumption. If a reorg deeper than this number of
529 /// blocks occurs, counterparties may be able to steal funds or claims made by and balances exposed
530 /// by a [`ChannelMonitor`] may be incorrect.
533 pub static ANTI_REORG_DELAY: u32 = lightning::chain::channelmonitor::ANTI_REORG_DELAY;
534 /// Details about the balance(s) available for spending once the channel appears on chain.
536 /// See [`ChannelMonitor::get_claimable_balances`] for more details on when these will or will not
542 /// The channel is not yet closed (or the commitment or closing transaction has not yet
543 /// appeared in a block). The given balance is claimable (less on-chain fees) if the channel is
544 /// force-closed now.
545 ClaimableOnChannelClose {
546 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
547 /// required to do so.
548 claimable_amount_satoshis: u64,
550 /// The channel has been closed, and the given balance is ours but awaiting confirmations until
551 /// we consider it spendable.
552 ClaimableAwaitingConfirmations {
553 /// The amount available to claim, in satoshis, possibly excluding the on-chain fees which
554 /// were spent in broadcasting the transaction.
555 claimable_amount_satoshis: u64,
556 /// The height at which an [`Event::SpendableOutputs`] event will be generated for this
558 confirmation_height: u32,
560 /// The channel has been closed, and the given balance should be ours but awaiting spending
561 /// transaction confirmation. If the spending transaction does not confirm in time, it is
562 /// possible our counterparty can take the funds by broadcasting an HTLC timeout on-chain.
564 /// Once the spending transaction confirms, before it has reached enough confirmations to be
565 /// considered safe from chain reorganizations, the balance will instead be provided via
566 /// [`Balance::ClaimableAwaitingConfirmations`].
567 ContentiousClaimable {
568 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
569 /// required to do so.
570 claimable_amount_satoshis: u64,
571 /// The height at which the counterparty may be able to claim the balance if we have not
575 /// HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain
576 /// fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat
577 /// likely to be claimed by our counterparty before we do.
578 MaybeClaimableHTLCAwaitingTimeout {
579 /// The amount available to claim, in satoshis, excluding the on-chain fees which will be
580 /// required to do so.
581 claimable_amount_satoshis: u64,
582 /// The height at which we will be able to claim the balance if our counterparty has not
584 claimable_height: u32,
587 use lightning::chain::channelmonitor::Balance as nativeBalance;
590 pub(crate) fn to_native(&self) -> nativeBalance {
592 Balance::ClaimableOnChannelClose {ref claimable_amount_satoshis, } => {
593 let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone();
594 nativeBalance::ClaimableOnChannelClose {
595 claimable_amount_satoshis: claimable_amount_satoshis_nonref,
598 Balance::ClaimableAwaitingConfirmations {ref claimable_amount_satoshis, ref confirmation_height, } => {
599 let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone();
600 let mut confirmation_height_nonref = (*confirmation_height).clone();
601 nativeBalance::ClaimableAwaitingConfirmations {
602 claimable_amount_satoshis: claimable_amount_satoshis_nonref,
603 confirmation_height: confirmation_height_nonref,
606 Balance::ContentiousClaimable {ref claimable_amount_satoshis, ref timeout_height, } => {
607 let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone();
608 let mut timeout_height_nonref = (*timeout_height).clone();
609 nativeBalance::ContentiousClaimable {
610 claimable_amount_satoshis: claimable_amount_satoshis_nonref,
611 timeout_height: timeout_height_nonref,
614 Balance::MaybeClaimableHTLCAwaitingTimeout {ref claimable_amount_satoshis, ref claimable_height, } => {
615 let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone();
616 let mut claimable_height_nonref = (*claimable_height).clone();
617 nativeBalance::MaybeClaimableHTLCAwaitingTimeout {
618 claimable_amount_satoshis: claimable_amount_satoshis_nonref,
619 claimable_height: claimable_height_nonref,
625 pub(crate) fn into_native(self) -> nativeBalance {
627 Balance::ClaimableOnChannelClose {mut claimable_amount_satoshis, } => {
628 nativeBalance::ClaimableOnChannelClose {
629 claimable_amount_satoshis: claimable_amount_satoshis,
632 Balance::ClaimableAwaitingConfirmations {mut claimable_amount_satoshis, mut confirmation_height, } => {
633 nativeBalance::ClaimableAwaitingConfirmations {
634 claimable_amount_satoshis: claimable_amount_satoshis,
635 confirmation_height: confirmation_height,
638 Balance::ContentiousClaimable {mut claimable_amount_satoshis, mut timeout_height, } => {
639 nativeBalance::ContentiousClaimable {
640 claimable_amount_satoshis: claimable_amount_satoshis,
641 timeout_height: timeout_height,
644 Balance::MaybeClaimableHTLCAwaitingTimeout {mut claimable_amount_satoshis, mut claimable_height, } => {
645 nativeBalance::MaybeClaimableHTLCAwaitingTimeout {
646 claimable_amount_satoshis: claimable_amount_satoshis,
647 claimable_height: claimable_height,
653 pub(crate) fn from_native(native: &nativeBalance) -> Self {
655 nativeBalance::ClaimableOnChannelClose {ref claimable_amount_satoshis, } => {
656 let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone();
657 Balance::ClaimableOnChannelClose {
658 claimable_amount_satoshis: claimable_amount_satoshis_nonref,
661 nativeBalance::ClaimableAwaitingConfirmations {ref claimable_amount_satoshis, ref confirmation_height, } => {
662 let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone();
663 let mut confirmation_height_nonref = (*confirmation_height).clone();
664 Balance::ClaimableAwaitingConfirmations {
665 claimable_amount_satoshis: claimable_amount_satoshis_nonref,
666 confirmation_height: confirmation_height_nonref,
669 nativeBalance::ContentiousClaimable {ref claimable_amount_satoshis, ref timeout_height, } => {
670 let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone();
671 let mut timeout_height_nonref = (*timeout_height).clone();
672 Balance::ContentiousClaimable {
673 claimable_amount_satoshis: claimable_amount_satoshis_nonref,
674 timeout_height: timeout_height_nonref,
677 nativeBalance::MaybeClaimableHTLCAwaitingTimeout {ref claimable_amount_satoshis, ref claimable_height, } => {
678 let mut claimable_amount_satoshis_nonref = (*claimable_amount_satoshis).clone();
679 let mut claimable_height_nonref = (*claimable_height).clone();
680 Balance::MaybeClaimableHTLCAwaitingTimeout {
681 claimable_amount_satoshis: claimable_amount_satoshis_nonref,
682 claimable_height: claimable_height_nonref,
688 pub(crate) fn native_into(native: nativeBalance) -> Self {
690 nativeBalance::ClaimableOnChannelClose {mut claimable_amount_satoshis, } => {
691 Balance::ClaimableOnChannelClose {
692 claimable_amount_satoshis: claimable_amount_satoshis,
695 nativeBalance::ClaimableAwaitingConfirmations {mut claimable_amount_satoshis, mut confirmation_height, } => {
696 Balance::ClaimableAwaitingConfirmations {
697 claimable_amount_satoshis: claimable_amount_satoshis,
698 confirmation_height: confirmation_height,
701 nativeBalance::ContentiousClaimable {mut claimable_amount_satoshis, mut timeout_height, } => {
702 Balance::ContentiousClaimable {
703 claimable_amount_satoshis: claimable_amount_satoshis,
704 timeout_height: timeout_height,
707 nativeBalance::MaybeClaimableHTLCAwaitingTimeout {mut claimable_amount_satoshis, mut claimable_height, } => {
708 Balance::MaybeClaimableHTLCAwaitingTimeout {
709 claimable_amount_satoshis: claimable_amount_satoshis,
710 claimable_height: claimable_height,
716 /// Frees any resources used by the Balance
718 pub extern "C" fn Balance_free(this_ptr: Balance) { }
719 /// Creates a copy of the Balance
721 pub extern "C" fn Balance_clone(orig: &Balance) -> Balance {
725 /// Utility method to constructs a new ClaimableOnChannelClose-variant Balance
726 pub extern "C" fn Balance_claimable_on_channel_close(claimable_amount_satoshis: u64) -> Balance {
727 Balance::ClaimableOnChannelClose {
728 claimable_amount_satoshis,
732 /// Utility method to constructs a new ClaimableAwaitingConfirmations-variant Balance
733 pub extern "C" fn Balance_claimable_awaiting_confirmations(claimable_amount_satoshis: u64, confirmation_height: u32) -> Balance {
734 Balance::ClaimableAwaitingConfirmations {
735 claimable_amount_satoshis,
740 /// Utility method to constructs a new ContentiousClaimable-variant Balance
741 pub extern "C" fn Balance_contentious_claimable(claimable_amount_satoshis: u64, timeout_height: u32) -> Balance {
742 Balance::ContentiousClaimable {
743 claimable_amount_satoshis,
748 /// Utility method to constructs a new MaybeClaimableHTLCAwaitingTimeout-variant Balance
749 pub extern "C" fn Balance_maybe_claimable_htlcawaiting_timeout(claimable_amount_satoshis: u64, claimable_height: u32) -> Balance {
750 Balance::MaybeClaimableHTLCAwaitingTimeout {
751 claimable_amount_satoshis,
755 /// Checks if two Balances contain equal inner contents.
756 /// This ignores pointers and is_owned flags and looks at the values in fields.
758 pub extern "C" fn Balance_eq(a: &Balance, b: &Balance) -> bool {
759 if &a.to_native() == &b.to_native() { true } else { false }
762 use lightning::chain::channelmonitor::ChannelMonitor as nativeChannelMonitorImport;
763 pub(crate) type nativeChannelMonitor = nativeChannelMonitorImport<crate::lightning::chain::keysinterface::Sign>;
765 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
766 /// on-chain transactions to ensure no loss of funds occurs.
768 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
769 /// information and are actively monitoring the chain.
771 /// Pending Events or updated HTLCs which have not yet been read out by
772 /// get_and_clear_pending_monitor_events or get_and_clear_pending_events are serialized to disk and
773 /// reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
774 /// gotten are fully handled before re-serializing the new state.
776 /// Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
777 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
778 /// the \"reorg path\" (ie disconnecting blocks until you find a common ancestor from both the
779 /// returned block hash and the the current chain and then reconnecting blocks to get to the
780 /// best chain) upon deserializing the object!
783 pub struct ChannelMonitor {
784 /// A pointer to the opaque Rust object.
786 /// Nearly everywhere, inner must be non-null, however in places where
787 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
788 pub inner: *mut nativeChannelMonitor,
789 /// Indicates that this is the only struct which contains the same pointer.
791 /// Rust functions which take ownership of an object provided via an argument require
792 /// this to be true and invalidate the object pointed to by inner.
796 impl Drop for ChannelMonitor {
798 if self.is_owned && !<*mut nativeChannelMonitor>::is_null(self.inner) {
799 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
803 /// Frees any resources used by the ChannelMonitor, if is_owned is set and inner is non-NULL.
805 pub extern "C" fn ChannelMonitor_free(this_obj: ChannelMonitor) { }
807 /// Used only if an object of this type is returned as a trait impl by a method
808 pub(crate) extern "C" fn ChannelMonitor_free_void(this_ptr: *mut c_void) {
809 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeChannelMonitor); }
812 impl ChannelMonitor {
813 pub(crate) fn get_native_ref(&self) -> &'static nativeChannelMonitor {
814 unsafe { &*ObjOps::untweak_ptr(self.inner) }
816 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeChannelMonitor {
817 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
819 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
820 pub(crate) fn take_inner(mut self) -> *mut nativeChannelMonitor {
821 assert!(self.is_owned);
822 let ret = ObjOps::untweak_ptr(self.inner);
823 self.inner = std::ptr::null_mut();
828 /// Serialize the ChannelMonitor object into a byte array which can be read by ChannelMonitor_read
829 pub extern "C" fn ChannelMonitor_write(obj: &ChannelMonitor) -> crate::c_types::derived::CVec_u8Z {
830 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
833 pub(crate) extern "C" fn ChannelMonitor_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
834 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeChannelMonitor) })
836 /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
839 /// panics if the given update is not the next update by update_id.
842 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 {
843 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.update_monitor(updates.get_native_ref(), broadcaster, fee_estimator, logger);
844 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: ObjOps::heap_alloc(e), is_owned: true } }).into() };
848 /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
852 pub extern "C" fn ChannelMonitor_get_latest_update_id(this_arg: &ChannelMonitor) -> u64 {
853 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_latest_update_id();
857 /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
860 pub extern "C" fn ChannelMonitor_get_funding_txo(this_arg: &ChannelMonitor) -> crate::c_types::derived::C2Tuple_OutPointScriptZ {
861 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_funding_txo();
862 let (mut orig_ret_0, mut orig_ret_1) = ret; let mut local_ret = (crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(orig_ret_0), is_owned: true }, orig_ret_1.into_bytes().into()).into();
866 /// Gets a list of txids, with their output scripts (in the order they appear in the
867 /// transaction), which we must learn about spends of via block_connected().
870 pub extern "C" fn ChannelMonitor_get_outputs_to_watch(this_arg: &ChannelMonitor) -> crate::c_types::derived::CVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ {
871 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_outputs_to_watch();
872 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 }); };
876 /// Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
877 /// calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
878 /// have been registered.
880 pub extern "C" fn ChannelMonitor_load_outputs_to_watch(this_arg: &ChannelMonitor, filter: &crate::lightning::chain::Filter) {
881 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.load_outputs_to_watch(filter)
884 /// Get the list of HTLCs who's status has been updated on chain. This should be called by
885 /// ChannelManager via [`chain::Watch::release_pending_monitor_events`].
888 pub extern "C" fn ChannelMonitor_get_and_clear_pending_monitor_events(this_arg: &ChannelMonitor) -> crate::c_types::derived::CVec_MonitorEventZ {
889 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_and_clear_pending_monitor_events();
890 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::chain::channelmonitor::MonitorEvent::native_into(item) }); };
894 /// Gets the list of pending events which were generated by previous actions, clearing the list
897 /// This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
898 /// EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
899 /// no internal locking in ChannelMonitors.
902 pub extern "C" fn ChannelMonitor_get_and_clear_pending_events(this_arg: &ChannelMonitor) -> crate::c_types::derived::CVec_EventZ {
903 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_and_clear_pending_events();
904 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::util::events::Event::native_into(item) }); };
908 /// Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
909 /// the Channel was out-of-date. You may use it to get a broadcastable holder toxic tx in case of
910 /// fallen-behind, i.e when receiving a channel_reestablish with a proof that our counterparty side knows
911 /// a higher revocation secret than the holder commitment number we are aware of. Broadcasting these
912 /// transactions are UNSAFE, as they allow counterparty side to punish you. Nevertheless you may want to
913 /// broadcast them if counterparty don't close channel with his higher commitment transaction after a
914 /// substantial amount of time (a month or even a year) to get back funds. Best may be to contact
915 /// out-of-band the other node operator to coordinate with him if option is available to you.
916 /// In any-case, choice is up to the user.
919 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 {
920 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_latest_holder_commitment_txn(logger);
921 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::c_types::Transaction::from_bitcoin(&item) }); };
925 /// Processes transactions in a newly connected block, which may result in any of the following:
926 /// - update the monitor's state against resolved HTLCs
927 /// - punish the counterparty in the case of seeing a revoked commitment transaction
928 /// - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
929 /// - detect settled outputs for later spending
930 /// - schedule and bump any in-flight claims
932 /// Returns any new outputs to watch from `txdata`; after called, these are also included in
933 /// [`get_outputs_to_watch`].
935 /// [`get_outputs_to_watch`]: #method.get_outputs_to_watch
938 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 {
939 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 }); };
940 let mut ret = unsafe { &*ObjOps::untweak_ptr(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);
941 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 }); };
945 /// Determines if the disconnected block contained any transactions of interest and updates
948 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) {
949 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.block_disconnected(&::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height, broadcaster, fee_estimator, logger)
952 /// Processes transactions confirmed in a block with the given header and height, returning new
953 /// outputs to watch. See [`block_connected`] for details.
955 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
956 /// blocks. See [`chain::Confirm`] for calling expectations.
958 /// [`block_connected`]: Self::block_connected
961 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 {
962 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 }); };
963 let mut ret = unsafe { &*ObjOps::untweak_ptr(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);
964 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 }); };
968 /// Processes a transaction that was reorganized out of the chain.
970 /// Used instead of [`block_disconnected`] by clients that are notified of transactions rather
971 /// than blocks. See [`chain::Confirm`] for calling expectations.
973 /// [`block_disconnected`]: Self::block_disconnected
975 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) {
976 unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.transaction_unconfirmed(&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*txid }[..]).unwrap(), broadcaster, fee_estimator, logger)
979 /// Updates the monitor with the current best chain tip, returning new outputs to watch. See
980 /// [`block_connected`] for details.
982 /// Used instead of [`block_connected`] by clients that are notified of transactions rather than
983 /// blocks. See [`chain::Confirm`] for calling expectations.
985 /// [`block_connected`]: Self::block_connected
988 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 {
989 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.best_block_updated(&::bitcoin::consensus::encode::deserialize(unsafe { &*header }).unwrap(), height, broadcaster, fee_estimator, logger);
990 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 }); };
994 /// Returns the set of txids that should be monitored for re-organization out of the chain.
997 pub extern "C" fn ChannelMonitor_get_relevant_txids(this_arg: &ChannelMonitor) -> crate::c_types::derived::CVec_TxidZ {
998 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_relevant_txids();
999 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::c_types::ThirtyTwoBytes { data: item.into_inner() } }); };
1003 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
1004 /// [`chain::Confirm`] interfaces.
1007 pub extern "C" fn ChannelMonitor_current_best_block(this_arg: &ChannelMonitor) -> crate::lightning::chain::BestBlock {
1008 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.current_best_block();
1009 crate::lightning::chain::BestBlock { inner: ObjOps::heap_alloc(ret), is_owned: true }
1012 /// Gets the balances in this channel which are either claimable by us if we were to
1013 /// force-close the channel now or which are claimable on-chain (possibly awaiting
1016 /// Any balances in the channel which are available on-chain (excluding on-chain fees) are
1017 /// included here until an [`Event::SpendableOutputs`] event has been generated for the
1018 /// balance, or until our counterparty has claimed the balance and accrued several
1019 /// confirmations on the claim transaction.
1021 /// Note that the balances available when you or your counterparty have broadcasted revoked
1022 /// state(s) may not be fully captured here.
1024 /// See [`Balance`] for additional details on the types of claimable balances which
1025 /// may be returned here and their meanings.
1028 pub extern "C" fn ChannelMonitor_get_claimable_balances(this_arg: &ChannelMonitor) -> crate::c_types::derived::CVec_BalanceZ {
1029 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.get_claimable_balances();
1030 let mut local_ret = Vec::new(); for mut item in ret.drain(..) { local_ret.push( { crate::lightning::chain::channelmonitor::Balance::native_into(item) }); };
1035 /// Read a C2Tuple_BlockHashChannelMonitorZ from a byte array, created by C2Tuple_BlockHashChannelMonitorZ_write
1036 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 {
1038 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);
1039 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: ObjOps::heap_alloc(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: ObjOps::heap_alloc(e), is_owned: true } }).into() };