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 //! Structs and traits which allow other parts of rust-lightning to interact with the blockchain.
11 use std::str::FromStr;
13 use bitcoin::hashes::Hash;
14 use crate::c_types::*;
16 pub mod chaininterface;
18 pub mod channelmonitor;
20 pub mod keysinterface;
23 use std::str::FromStr;
25 use bitcoin::hashes::Hash;
26 use crate::c_types::*;
31 use std::str::FromStr;
33 use bitcoin::hashes::Hash;
34 use crate::c_types::*;
37 /// An error when accessing the chain via [`Access`].
41 pub enum AccessError {
42 /// The requested chain is unknown.
44 /// The requested transaction doesn't exist or hasn't confirmed.
47 use lightning::chain::AccessError as nativeAccessError;
50 pub(crate) fn to_native(&self) -> nativeAccessError {
52 AccessError::UnknownChain => nativeAccessError::UnknownChain,
53 AccessError::UnknownTx => nativeAccessError::UnknownTx,
57 pub(crate) fn into_native(self) -> nativeAccessError {
59 AccessError::UnknownChain => nativeAccessError::UnknownChain,
60 AccessError::UnknownTx => nativeAccessError::UnknownTx,
64 pub(crate) fn from_native(native: &nativeAccessError) -> Self {
66 nativeAccessError::UnknownChain => AccessError::UnknownChain,
67 nativeAccessError::UnknownTx => AccessError::UnknownTx,
71 pub(crate) fn native_into(native: nativeAccessError) -> Self {
73 nativeAccessError::UnknownChain => AccessError::UnknownChain,
74 nativeAccessError::UnknownTx => AccessError::UnknownTx,
78 /// Creates a copy of the AccessError
80 pub extern "C" fn AccessError_clone(orig: &AccessError) -> AccessError {
83 /// The `Access` trait defines behavior for accessing chain data and state, such as blocks and
87 /// An opaque pointer which is passed to your function implementations as an argument.
88 /// This has no meaning in the LDK, and can be NULL or any other value.
89 pub this_arg: *mut c_void,
90 /// Returns the transaction output of a funding transaction encoded by [`short_channel_id`].
91 /// Returns an error if `genesis_hash` is for a different chain or if such a transaction output
94 /// [`short_channel_id`]: https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md#definition-of-short_channel_id
96 pub get_utxo: extern "C" fn (this_arg: *const c_void, genesis_hash: *const [u8; 32], short_channel_id: u64) -> crate::c_types::derived::CResult_TxOutAccessErrorZ,
97 /// Frees any resources associated with this object given its this_arg pointer.
98 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
99 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
101 unsafe impl Send for Access {}
102 unsafe impl Sync for Access {}
104 use lightning::chain::Access as rustAccess;
105 impl rustAccess for Access {
106 fn get_utxo(&self, mut genesis_hash: &bitcoin::hash_types::BlockHash, mut short_channel_id: u64) -> Result<bitcoin::blockdata::transaction::TxOut, lightning::chain::AccessError> {
107 let mut ret = (self.get_utxo)(self.this_arg, genesis_hash.as_inner(), short_channel_id);
108 let mut local_ret = match ret.result_ok { true => Ok( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.result)) }).into_rust() }), false => Err( { (*unsafe { Box::from_raw(<*mut _>::take_ptr(&mut ret.contents.err)) }).into_native() })};
113 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
114 // directly as a Deref trait in higher-level structs:
115 impl std::ops::Deref for Access {
117 fn deref(&self) -> &Self {
121 /// Calls the free function if one is set
123 pub extern "C" fn Access_free(this_ptr: Access) { }
124 impl Drop for Access {
126 if let Some(f) = self.free {
131 /// The `Listen` trait is used to notify when blocks have been connected or disconnected from the
134 /// Useful when needing to replay chain data upon startup or as new chain events occur. Clients
135 /// sourcing chain data using a block-oriented API should prefer this interface over [`Confirm`].
136 /// Such clients fetch the entire header chain whereas clients using [`Confirm`] only fetch headers
140 /// An opaque pointer which is passed to your function implementations as an argument.
141 /// This has no meaning in the LDK, and can be NULL or any other value.
142 pub this_arg: *mut c_void,
143 /// Notifies the listener that a block was added at the given height.
144 pub block_connected: extern "C" fn (this_arg: *const c_void, block: crate::c_types::u8slice, height: u32),
145 /// Notifies the listener that a block was removed at the given height.
146 pub block_disconnected: extern "C" fn (this_arg: *const c_void, header: *const [u8; 80], height: u32),
147 /// Frees any resources associated with this object given its this_arg pointer.
148 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
149 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
151 unsafe impl Send for Listen {}
152 unsafe impl Sync for Listen {}
154 use lightning::chain::Listen as rustListen;
155 impl rustListen for Listen {
156 fn block_connected(&self, mut block: &bitcoin::blockdata::block::Block, mut height: u32) {
157 let mut local_block = ::bitcoin::consensus::encode::serialize(block);
158 (self.block_connected)(self.this_arg, crate::c_types::u8slice::from_slice(&local_block), height)
160 fn block_disconnected(&self, mut header: &bitcoin::blockdata::block::BlockHeader, mut height: u32) {
161 let mut local_header = { let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(header)); s };
162 (self.block_disconnected)(self.this_arg, &local_header, height)
166 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
167 // directly as a Deref trait in higher-level structs:
168 impl std::ops::Deref for Listen {
170 fn deref(&self) -> &Self {
174 /// Calls the free function if one is set
176 pub extern "C" fn Listen_free(this_ptr: Listen) { }
177 impl Drop for Listen {
179 if let Some(f) = self.free {
184 /// The `Confirm` trait is used to notify when transactions have been confirmed on chain or
185 /// unconfirmed during a chain reorganization.
187 /// Clients sourcing chain data using a transaction-oriented API should prefer this interface over
188 /// [`Listen`]. For instance, an Electrum client may implement [`Filter`] by subscribing to activity
189 /// related to registered transactions and outputs. Upon notification, it would pass along the
190 /// matching transactions using this interface.
194 /// The intended use is as follows:
195 /// - Call [`transactions_confirmed`] to process any on-chain activity of interest.
196 /// - Call [`transaction_unconfirmed`] to process any transaction returned by [`get_relevant_txids`]
197 /// that has been reorganized out of the chain.
198 /// - Call [`best_block_updated`] whenever a new chain tip becomes available.
202 /// Clients must call these methods in chain order. Specifically:
203 /// - Transactions confirmed in a block must be given before transactions confirmed in a later
205 /// - Dependent transactions within the same block must be given in topological order, possibly in
207 /// - Unconfirmed transactions must be given after the original confirmations and before any
210 /// See individual method documentation for further details.
212 /// [`transactions_confirmed`]: Self::transactions_confirmed
213 /// [`transaction_unconfirmed`]: Self::transaction_unconfirmed
214 /// [`best_block_updated`]: Self::best_block_updated
215 /// [`get_relevant_txids`]: Self::get_relevant_txids
218 /// An opaque pointer which is passed to your function implementations as an argument.
219 /// This has no meaning in the LDK, and can be NULL or any other value.
220 pub this_arg: *mut c_void,
221 /// Processes transactions confirmed in a block with a given header and height.
223 /// Should be called for any transactions registered by [`Filter::register_tx`] or any
224 /// transactions spending an output registered by [`Filter::register_output`]. Such transactions
225 /// appearing in the same block do not need to be included in the same call; instead, multiple
226 /// calls with additional transactions may be made so long as they are made in [chain order].
228 /// May be called before or after [`best_block_updated`] for the corresponding block. However,
229 /// in the event of a chain reorganization, it must not be called with a `header` that is no
230 /// longer in the chain as of the last call to [`best_block_updated`].
232 /// [chain order]: Confirm#Order
233 /// [`best_block_updated`]: Self::best_block_updated
234 pub transactions_confirmed: extern "C" fn (this_arg: *const c_void, header: *const [u8; 80], txdata: crate::c_types::derived::CVec_C2Tuple_usizeTransactionZZ, height: u32),
235 /// Processes a transaction that is no longer confirmed as result of a chain reorganization.
237 /// Should be called for any transaction returned by [`get_relevant_txids`] if it has been
238 /// reorganized out of the best chain. Once called, the given transaction should not be returned
239 /// by [`get_relevant_txids`] unless it has been reconfirmed via [`transactions_confirmed`].
241 /// [`get_relevant_txids`]: Self::get_relevant_txids
242 /// [`transactions_confirmed`]: Self::transactions_confirmed
243 pub transaction_unconfirmed: extern "C" fn (this_arg: *const c_void, txid: *const [u8; 32]),
244 /// Processes an update to the best header connected at the given height.
246 /// Should be called when a new header is available but may be skipped for intermediary blocks
247 /// if they become available at the same time.
248 pub best_block_updated: extern "C" fn (this_arg: *const c_void, header: *const [u8; 80], height: u32),
249 /// Returns transactions that should be monitored for reorganization out of the chain.
251 /// Should include any transactions passed to [`transactions_confirmed`] that have insufficient
252 /// confirmations to be safe from a chain reorganization. Should not include any transactions
253 /// passed to [`transaction_unconfirmed`] unless later reconfirmed.
255 /// May be called to determine the subset of transactions that must still be monitored for
256 /// reorganization. Will be idempotent between calls but may change as a result of calls to the
257 /// other interface methods. Thus, this is useful to determine which transactions may need to be
258 /// given to [`transaction_unconfirmed`].
260 /// [`transactions_confirmed`]: Self::transactions_confirmed
261 /// [`transaction_unconfirmed`]: Self::transaction_unconfirmed
263 pub get_relevant_txids: extern "C" fn (this_arg: *const c_void) -> crate::c_types::derived::CVec_TxidZ,
264 /// Frees any resources associated with this object given its this_arg pointer.
265 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
266 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
268 unsafe impl Send for Confirm {}
269 unsafe impl Sync for Confirm {}
271 use lightning::chain::Confirm as rustConfirm;
272 impl rustConfirm for Confirm {
273 fn transactions_confirmed(&self, mut header: &bitcoin::blockdata::block::BlockHeader, mut txdata: &lightning::chain::transaction::TransactionData, mut height: u32) {
274 let mut local_header = { let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(header)); s };
275 let mut local_txdata = Vec::new(); for item in txdata.iter() { local_txdata.push( { let (mut orig_txdata_0_0, mut orig_txdata_0_1) = item; let mut local_txdata_0 = (orig_txdata_0_0, crate::c_types::Transaction::from_bitcoin(&orig_txdata_0_1)).into(); local_txdata_0 }); };
276 (self.transactions_confirmed)(self.this_arg, &local_header, local_txdata.into(), height)
278 fn transaction_unconfirmed(&self, mut txid: &bitcoin::hash_types::Txid) {
279 (self.transaction_unconfirmed)(self.this_arg, txid.as_inner())
281 fn best_block_updated(&self, mut header: &bitcoin::blockdata::block::BlockHeader, mut height: u32) {
282 let mut local_header = { let mut s = [0u8; 80]; s[..].copy_from_slice(&::bitcoin::consensus::encode::serialize(header)); s };
283 (self.best_block_updated)(self.this_arg, &local_header, height)
285 fn get_relevant_txids(&self) -> Vec<bitcoin::hash_types::Txid> {
286 let mut ret = (self.get_relevant_txids)(self.this_arg);
287 let mut local_ret = Vec::new(); for mut item in ret.into_rust().drain(..) { local_ret.push( { ::bitcoin::hash_types::Txid::from_slice(&item.data[..]).unwrap() }); };
292 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
293 // directly as a Deref trait in higher-level structs:
294 impl std::ops::Deref for Confirm {
296 fn deref(&self) -> &Self {
300 /// Calls the free function if one is set
302 pub extern "C" fn Confirm_free(this_ptr: Confirm) { }
303 impl Drop for Confirm {
305 if let Some(f) = self.free {
310 /// The `Watch` trait defines behavior for watching on-chain activity pertaining to channels as
311 /// blocks are connected and disconnected.
313 /// Each channel is associated with a [`ChannelMonitor`]. Implementations of this trait are
314 /// responsible for maintaining a set of monitors such that they can be updated accordingly as
315 /// channel state changes and HTLCs are resolved. See method documentation for specific
318 /// Implementations **must** ensure that updates are successfully applied and persisted upon method
319 /// completion. If an update fails with a [`PermanentFailure`], then it must immediately shut down
320 /// without taking any further action such as persisting the current state.
322 /// If an implementation maintains multiple instances of a channel's monitor (e.g., by storing
323 /// backup copies), then it must ensure that updates are applied across all instances. Otherwise, it
324 /// could result in a revoked transaction being broadcast, allowing the counterparty to claim all
325 /// funds in the channel. See [`ChannelMonitorUpdateErr`] for more details about how to handle
326 /// multiple instances.
328 /// [`ChannelMonitor`]: channelmonitor::ChannelMonitor
329 /// [`ChannelMonitorUpdateErr`]: channelmonitor::ChannelMonitorUpdateErr
330 /// [`PermanentFailure`]: channelmonitor::ChannelMonitorUpdateErr::PermanentFailure
333 /// An opaque pointer which is passed to your function implementations as an argument.
334 /// This has no meaning in the LDK, and can be NULL or any other value.
335 pub this_arg: *mut c_void,
336 /// Watches a channel identified by `funding_txo` using `monitor`.
338 /// Implementations are responsible for watching the chain for the funding transaction along
339 /// with any spends of outputs returned by [`get_outputs_to_watch`]. In practice, this means
340 /// calling [`block_connected`] and [`block_disconnected`] on the monitor.
342 /// [`get_outputs_to_watch`]: channelmonitor::ChannelMonitor::get_outputs_to_watch
343 /// [`block_connected`]: channelmonitor::ChannelMonitor::block_connected
344 /// [`block_disconnected`]: channelmonitor::ChannelMonitor::block_disconnected
346 pub watch_channel: extern "C" fn (this_arg: *const c_void, funding_txo: crate::lightning::chain::transaction::OutPoint, monitor: crate::lightning::chain::channelmonitor::ChannelMonitor) -> crate::c_types::derived::CResult_NoneChannelMonitorUpdateErrZ,
347 /// Updates a channel identified by `funding_txo` by applying `update` to its monitor.
349 /// Implementations must call [`update_monitor`] with the given update. See
350 /// [`ChannelMonitorUpdateErr`] for invariants around returning an error.
352 /// [`update_monitor`]: channelmonitor::ChannelMonitor::update_monitor
353 /// [`ChannelMonitorUpdateErr`]: channelmonitor::ChannelMonitorUpdateErr
355 pub update_channel: extern "C" fn (this_arg: *const c_void, funding_txo: crate::lightning::chain::transaction::OutPoint, update: crate::lightning::chain::channelmonitor::ChannelMonitorUpdate) -> crate::c_types::derived::CResult_NoneChannelMonitorUpdateErrZ,
356 /// Returns any monitor events since the last call. Subsequent calls must only return new
359 pub release_pending_monitor_events: extern "C" fn (this_arg: *const c_void) -> crate::c_types::derived::CVec_MonitorEventZ,
360 /// Frees any resources associated with this object given its this_arg pointer.
361 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
362 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
364 unsafe impl Send for Watch {}
365 unsafe impl Sync for Watch {}
367 use lightning::chain::Watch as rustWatch;
368 impl rustWatch<crate::lightning::chain::keysinterface::Sign> for Watch {
369 fn watch_channel(&self, mut funding_txo: lightning::chain::transaction::OutPoint, mut monitor: lightning::chain::channelmonitor::ChannelMonitor<crate::lightning::chain::keysinterface::Sign>) -> Result<(), lightning::chain::channelmonitor::ChannelMonitorUpdateErr> {
370 let mut ret = (self.watch_channel)(self.this_arg, crate::lightning::chain::transaction::OutPoint { inner: Box::into_raw(Box::new(funding_txo)), is_owned: true }, crate::lightning::chain::channelmonitor::ChannelMonitor { inner: Box::into_raw(Box::new(monitor)), is_owned: true });
371 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() })};
374 fn update_channel(&self, mut funding_txo: lightning::chain::transaction::OutPoint, mut update: lightning::chain::channelmonitor::ChannelMonitorUpdate) -> Result<(), lightning::chain::channelmonitor::ChannelMonitorUpdateErr> {
375 let mut ret = (self.update_channel)(self.this_arg, crate::lightning::chain::transaction::OutPoint { inner: Box::into_raw(Box::new(funding_txo)), is_owned: true }, crate::lightning::chain::channelmonitor::ChannelMonitorUpdate { inner: Box::into_raw(Box::new(update)), is_owned: true });
376 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() })};
379 fn release_pending_monitor_events(&self) -> Vec<lightning::chain::channelmonitor::MonitorEvent> {
380 let mut ret = (self.release_pending_monitor_events)(self.this_arg);
381 let mut local_ret = Vec::new(); for mut item in ret.into_rust().drain(..) { local_ret.push( { item.into_native() }); };
386 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
387 // directly as a Deref trait in higher-level structs:
388 impl std::ops::Deref for Watch {
390 fn deref(&self) -> &Self {
394 /// Calls the free function if one is set
396 pub extern "C" fn Watch_free(this_ptr: Watch) { }
397 impl Drop for Watch {
399 if let Some(f) = self.free {
404 /// The `Filter` trait defines behavior for indicating chain activity of interest pertaining to
407 /// This is useful in order to have a [`Watch`] implementation convey to a chain source which
408 /// transactions to be notified of. Notification may take the form of pre-filtering blocks or, in
409 /// the case of [BIP 157]/[BIP 158], only fetching a block if the compact filter matches. If
410 /// receiving full blocks from a chain source, any further filtering is unnecessary.
412 /// After an output has been registered, subsequent block retrievals from the chain source must not
413 /// exclude any transactions matching the new criteria nor any in-block descendants of such
416 /// Note that use as part of a [`Watch`] implementation involves reentrancy. Therefore, the `Filter`
417 /// should not block on I/O. Implementations should instead queue the newly monitored data to be
418 /// processed later. Then, in order to block until the data has been processed, any [`Watch`]
419 /// invocation that has called the `Filter` must return [`TemporaryFailure`].
421 /// [`TemporaryFailure`]: channelmonitor::ChannelMonitorUpdateErr::TemporaryFailure
422 /// [BIP 157]: https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki
423 /// [BIP 158]: https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki
426 /// An opaque pointer which is passed to your function implementations as an argument.
427 /// This has no meaning in the LDK, and can be NULL or any other value.
428 pub this_arg: *mut c_void,
429 /// Registers interest in a transaction with `txid` and having an output with `script_pubkey` as
430 /// a spending condition.
431 pub register_tx: extern "C" fn (this_arg: *const c_void, txid: *const [u8; 32], script_pubkey: crate::c_types::u8slice),
432 /// Registers interest in spends of a transaction output.
434 /// Optionally, when `output.block_hash` is set, should return any transaction spending the
435 /// output that is found in the corresponding block along with its index.
437 /// This return value is useful for Electrum clients in order to supply in-block descendant
438 /// transactions which otherwise were not included. This is not necessary for other clients if
439 /// such descendant transactions were already included (e.g., when a BIP 157 client provides the
442 pub register_output: extern "C" fn (this_arg: *const c_void, output: crate::lightning::chain::WatchedOutput) -> crate::c_types::derived::COption_C2Tuple_usizeTransactionZZ,
443 /// Frees any resources associated with this object given its this_arg pointer.
444 /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
445 pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
447 unsafe impl Send for Filter {}
448 unsafe impl Sync for Filter {}
450 use lightning::chain::Filter as rustFilter;
451 impl rustFilter for Filter {
452 fn register_tx(&self, mut txid: &bitcoin::hash_types::Txid, mut script_pubkey: &bitcoin::blockdata::script::Script) {
453 (self.register_tx)(self.this_arg, txid.as_inner(), crate::c_types::u8slice::from_slice(&script_pubkey[..]))
455 fn register_output(&self, mut output: lightning::chain::WatchedOutput) -> Option<(usize, bitcoin::blockdata::transaction::Transaction)> {
456 let mut ret = (self.register_output)(self.this_arg, crate::lightning::chain::WatchedOutput { inner: Box::into_raw(Box::new(output)), is_owned: true });
457 let mut local_ret = if ret.is_some() { Some( { let (mut orig_ret_0_0, mut orig_ret_0_1) = ret.take().to_rust(); let mut local_ret_0 = (orig_ret_0_0, orig_ret_0_1.into_bitcoin()); local_ret_0 }) } else { None };
462 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
463 // directly as a Deref trait in higher-level structs:
464 impl std::ops::Deref for Filter {
466 fn deref(&self) -> &Self {
470 /// Calls the free function if one is set
472 pub extern "C" fn Filter_free(this_ptr: Filter) { }
473 impl Drop for Filter {
475 if let Some(f) = self.free {
481 use lightning::chain::WatchedOutput as nativeWatchedOutputImport;
482 type nativeWatchedOutput = nativeWatchedOutputImport;
484 /// A transaction output watched by a [`ChannelMonitor`] for spends on-chain.
486 /// Used to convey to a [`Filter`] such an output with a given spending condition. Any transaction
487 /// spending the output must be given to [`ChannelMonitor::block_connected`] either directly or via
488 /// the return value of [`Filter::register_output`].
490 /// If `block_hash` is `Some`, this indicates the output was created in the corresponding block and
491 /// may have been spent there. See [`Filter::register_output`] for details.
493 /// [`ChannelMonitor`]: channelmonitor::ChannelMonitor
494 /// [`ChannelMonitor::block_connected`]: channelmonitor::ChannelMonitor::block_connected
497 pub struct WatchedOutput {
498 /// A pointer to the opaque Rust object.
500 /// Nearly everywhere, inner must be non-null, however in places where
501 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
502 pub inner: *mut nativeWatchedOutput,
503 /// Indicates that this is the only struct which contains the same pointer.
505 /// Rust functions which take ownership of an object provided via an argument require
506 /// this to be true and invalidate the object pointed to by inner.
510 impl Drop for WatchedOutput {
512 if self.is_owned && !<*mut nativeWatchedOutput>::is_null(self.inner) {
513 let _ = unsafe { Box::from_raw(self.inner) };
517 /// Frees any resources used by the WatchedOutput, if is_owned is set and inner is non-NULL.
519 pub extern "C" fn WatchedOutput_free(this_obj: WatchedOutput) { }
521 /// Used only if an object of this type is returned as a trait impl by a method
522 extern "C" fn WatchedOutput_free_void(this_ptr: *mut c_void) {
523 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeWatchedOutput); }
526 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
528 pub(crate) fn take_inner(mut self) -> *mut nativeWatchedOutput {
529 assert!(self.is_owned);
530 let ret = self.inner;
531 self.inner = std::ptr::null_mut();
535 /// First block where the transaction output may have been spent.
537 pub extern "C" fn WatchedOutput_get_block_hash(this_ptr: &WatchedOutput) -> crate::c_types::ThirtyTwoBytes {
538 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.block_hash;
539 let mut local_inner_val = if inner_val.is_none() { crate::c_types::ThirtyTwoBytes::null() } else { { crate::c_types::ThirtyTwoBytes { data: (inner_val.unwrap()).into_inner() } } };
542 /// First block where the transaction output may have been spent.
544 pub extern "C" fn WatchedOutput_set_block_hash(this_ptr: &mut WatchedOutput, mut val: crate::c_types::ThirtyTwoBytes) {
545 let mut local_val = if val.data == [0; 32] { None } else { Some( { ::bitcoin::hash_types::BlockHash::from_slice(&val.data[..]).unwrap() }) };
546 unsafe { &mut *this_ptr.inner }.block_hash = local_val;
548 /// Outpoint identifying the transaction output.
550 pub extern "C" fn WatchedOutput_get_outpoint(this_ptr: &WatchedOutput) -> crate::lightning::chain::transaction::OutPoint {
551 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.outpoint;
552 crate::lightning::chain::transaction::OutPoint { inner: unsafe { ( (&(*inner_val) as *const _) as *mut _) }, is_owned: false }
554 /// Outpoint identifying the transaction output.
556 pub extern "C" fn WatchedOutput_set_outpoint(this_ptr: &mut WatchedOutput, mut val: crate::lightning::chain::transaction::OutPoint) {
557 unsafe { &mut *this_ptr.inner }.outpoint = *unsafe { Box::from_raw(val.take_inner()) };
559 /// Spending condition of the transaction output.
561 pub extern "C" fn WatchedOutput_get_script_pubkey(this_ptr: &WatchedOutput) -> crate::c_types::u8slice {
562 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.script_pubkey;
563 crate::c_types::u8slice::from_slice(&inner_val[..])
565 /// Spending condition of the transaction output.
567 pub extern "C" fn WatchedOutput_set_script_pubkey(this_ptr: &mut WatchedOutput, mut val: crate::c_types::derived::CVec_u8Z) {
568 unsafe { &mut *this_ptr.inner }.script_pubkey = ::bitcoin::blockdata::script::Script::from(val.into_rust());
570 /// Constructs a new WatchedOutput given each field
573 pub extern "C" fn WatchedOutput_new(mut block_hash_arg: crate::c_types::ThirtyTwoBytes, mut outpoint_arg: crate::lightning::chain::transaction::OutPoint, mut script_pubkey_arg: crate::c_types::derived::CVec_u8Z) -> WatchedOutput {
574 let mut local_block_hash_arg = if block_hash_arg.data == [0; 32] { None } else { Some( { ::bitcoin::hash_types::BlockHash::from_slice(&block_hash_arg.data[..]).unwrap() }) };
575 WatchedOutput { inner: Box::into_raw(Box::new(nativeWatchedOutput {
576 block_hash: local_block_hash_arg,
577 outpoint: *unsafe { Box::from_raw(outpoint_arg.take_inner()) },
578 script_pubkey: ::bitcoin::blockdata::script::Script::from(script_pubkey_arg.into_rust()),
579 })), is_owned: true }
581 impl Clone for WatchedOutput {
582 fn clone(&self) -> Self {
584 inner: if <*mut nativeWatchedOutput>::is_null(self.inner) { std::ptr::null_mut() } else {
585 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
591 /// Used only if an object of this type is returned as a trait impl by a method
592 pub(crate) extern "C" fn WatchedOutput_clone_void(this_ptr: *const c_void) -> *mut c_void {
593 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeWatchedOutput)).clone() })) as *mut c_void
596 /// Creates a copy of the WatchedOutput
597 pub extern "C" fn WatchedOutput_clone(orig: &WatchedOutput) -> WatchedOutput {
600 /// Checks if two WatchedOutputs contain equal inner contents.
602 pub extern "C" fn WatchedOutput_hash(o: &WatchedOutput) -> u64 {
603 if o.inner.is_null() { return 0; }
604 // Note that we'd love to use std::collections::hash_map::DefaultHasher but it's not in core
606 let mut hasher = core::hash::SipHasher::new();
607 std::hash::Hash::hash(unsafe { &*o.inner }, &mut hasher);
608 std::hash::Hasher::finish(&hasher)