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 //! Types describing on-chain transactions.
11 use alloc::str::FromStr;
12 use alloc::string::String;
13 use core::ffi::c_void;
14 use core::convert::Infallible;
15 use bitcoin::hashes::Hash;
16 use crate::c_types::*;
17 #[cfg(feature="no-std")]
18 use alloc::{vec::Vec, boxed::Box};
21 use lightning::chain::transaction::OutPoint as nativeOutPointImport;
22 pub(crate) type nativeOutPoint = nativeOutPointImport;
24 /// A reference to a transaction output.
26 /// Differs from bitcoin::blockdata::transaction::OutPoint as the index is a u16 instead of u32
27 /// due to LN's restrictions on index values. Should reduce (possibly) unsafe conversions this way.
31 /// A pointer to the opaque Rust object.
33 /// Nearly everywhere, inner must be non-null, however in places where
34 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
35 pub inner: *mut nativeOutPoint,
36 /// Indicates that this is the only struct which contains the same pointer.
38 /// Rust functions which take ownership of an object provided via an argument require
39 /// this to be true and invalidate the object pointed to by inner.
43 impl Drop for OutPoint {
45 if self.is_owned && !<*mut nativeOutPoint>::is_null(self.inner) {
46 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
50 /// Frees any resources used by the OutPoint, if is_owned is set and inner is non-NULL.
52 pub extern "C" fn OutPoint_free(this_obj: OutPoint) { }
54 /// Used only if an object of this type is returned as a trait impl by a method
55 pub(crate) extern "C" fn OutPoint_free_void(this_ptr: *mut c_void) {
56 let _ = unsafe { Box::from_raw(this_ptr as *mut nativeOutPoint) };
60 pub(crate) fn get_native_ref(&self) -> &'static nativeOutPoint {
61 unsafe { &*ObjOps::untweak_ptr(self.inner) }
63 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeOutPoint {
64 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
66 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
67 pub(crate) fn take_inner(mut self) -> *mut nativeOutPoint {
68 assert!(self.is_owned);
69 let ret = ObjOps::untweak_ptr(self.inner);
70 self.inner = core::ptr::null_mut();
74 /// The referenced transaction's txid.
76 pub extern "C" fn OutPoint_get_txid(this_ptr: &OutPoint) -> *const [u8; 32] {
77 let mut inner_val = &mut this_ptr.get_native_mut_ref().txid;
80 /// The referenced transaction's txid.
82 pub extern "C" fn OutPoint_set_txid(this_ptr: &mut OutPoint, mut val: crate::c_types::ThirtyTwoBytes) {
83 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.txid = ::bitcoin::hash_types::Txid::from_slice(&val.data[..]).unwrap();
85 /// The index of the referenced output in its transaction's vout.
87 pub extern "C" fn OutPoint_get_index(this_ptr: &OutPoint) -> u16 {
88 let mut inner_val = &mut this_ptr.get_native_mut_ref().index;
91 /// The index of the referenced output in its transaction's vout.
93 pub extern "C" fn OutPoint_set_index(this_ptr: &mut OutPoint, mut val: u16) {
94 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.index = val;
96 /// Constructs a new OutPoint given each field
99 pub extern "C" fn OutPoint_new(mut txid_arg: crate::c_types::ThirtyTwoBytes, mut index_arg: u16) -> OutPoint {
100 OutPoint { inner: ObjOps::heap_alloc(nativeOutPoint {
101 txid: ::bitcoin::hash_types::Txid::from_slice(&txid_arg.data[..]).unwrap(),
105 impl Clone for OutPoint {
106 fn clone(&self) -> Self {
108 inner: if <*mut nativeOutPoint>::is_null(self.inner) { core::ptr::null_mut() } else {
109 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
115 /// Used only if an object of this type is returned as a trait impl by a method
116 pub(crate) extern "C" fn OutPoint_clone_void(this_ptr: *const c_void) -> *mut c_void {
117 Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativeOutPoint)).clone() })) as *mut c_void
120 /// Creates a copy of the OutPoint
121 pub extern "C" fn OutPoint_clone(orig: &OutPoint) -> OutPoint {
124 /// Checks if two OutPoints contain equal inner contents.
125 /// This ignores pointers and is_owned flags and looks at the values in fields.
126 /// Two objects with NULL inner values will be considered "equal" here.
128 pub extern "C" fn OutPoint_eq(a: &OutPoint, b: &OutPoint) -> bool {
129 if a.inner == b.inner { return true; }
130 if a.inner.is_null() || b.inner.is_null() { return false; }
131 if a.get_native_ref() == b.get_native_ref() { true } else { false }
133 /// Get a string which allows debug introspection of a OutPoint object
134 pub extern "C" fn OutPoint_debug_str_void(o: *const c_void) -> Str {
135 alloc::format!("{:?}", unsafe { o as *const crate::lightning::chain::transaction::OutPoint }).into()}
136 /// Generates a non-cryptographic 64-bit hash of the OutPoint.
138 pub extern "C" fn OutPoint_hash(o: &OutPoint) -> u64 {
139 if o.inner.is_null() { return 0; }
140 // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
142 let mut hasher = core::hash::SipHasher::new();
143 core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
144 core::hash::Hasher::finish(&hasher)
147 /// Serialize the OutPoint object into a byte array which can be read by OutPoint_read
148 pub extern "C" fn OutPoint_write(obj: &crate::lightning::chain::transaction::OutPoint) -> crate::c_types::derived::CVec_u8Z {
149 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
152 pub(crate) extern "C" fn OutPoint_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
153 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeOutPoint) })
156 /// Read a OutPoint from a byte array, created by OutPoint_write
157 pub extern "C" fn OutPoint_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_OutPointDecodeErrorZ {
158 let res: Result<lightning::chain::transaction::OutPoint, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
159 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::lightning::chain::transaction::OutPoint { inner: ObjOps::heap_alloc(o), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::lightning::ln::msgs::DecodeError::native_into(e) }).into() };