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 std::str::FromStr;
13 use bitcoin::hashes::Hash;
14 use crate::c_types::*;
17 use lightning::chain::transaction::OutPoint as nativeOutPointImport;
18 type nativeOutPoint = nativeOutPointImport;
20 /// A reference to a transaction output.
22 /// Differs from bitcoin::blockdata::transaction::OutPoint as the index is a u16 instead of u32
23 /// due to LN's restrictions on index values. Should reduce (possibly) unsafe conversions this way.
27 /// A pointer to the opaque Rust object.
29 /// Nearly everywhere, inner must be non-null, however in places where
30 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
31 pub inner: *mut nativeOutPoint,
32 /// Indicates that this is the only struct which contains the same pointer.
34 /// Rust functions which take ownership of an object provided via an argument require
35 /// this to be true and invalidate the object pointed to by inner.
39 impl Drop for OutPoint {
41 if self.is_owned && !<*mut nativeOutPoint>::is_null(self.inner) {
42 let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
46 /// Frees any resources used by the OutPoint, if is_owned is set and inner is non-NULL.
48 pub extern "C" fn OutPoint_free(this_obj: OutPoint) { }
50 /// Used only if an object of this type is returned as a trait impl by a method
51 extern "C" fn OutPoint_free_void(this_ptr: *mut c_void) {
52 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeOutPoint); }
56 pub(crate) fn get_native_ref(&self) -> &'static nativeOutPoint {
57 unsafe { &*ObjOps::untweak_ptr(self.inner) }
59 pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeOutPoint {
60 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
62 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
63 pub(crate) fn take_inner(mut self) -> *mut nativeOutPoint {
64 assert!(self.is_owned);
65 let ret = ObjOps::untweak_ptr(self.inner);
66 self.inner = std::ptr::null_mut();
70 /// The referenced transaction's txid.
72 pub extern "C" fn OutPoint_get_txid(this_ptr: &OutPoint) -> *const [u8; 32] {
73 let mut inner_val = &mut this_ptr.get_native_mut_ref().txid;
76 /// The referenced transaction's txid.
78 pub extern "C" fn OutPoint_set_txid(this_ptr: &mut OutPoint, mut val: crate::c_types::ThirtyTwoBytes) {
79 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.txid = ::bitcoin::hash_types::Txid::from_slice(&val.data[..]).unwrap();
81 /// The index of the referenced output in its transaction's vout.
83 pub extern "C" fn OutPoint_get_index(this_ptr: &OutPoint) -> u16 {
84 let mut inner_val = &mut this_ptr.get_native_mut_ref().index;
87 /// The index of the referenced output in its transaction's vout.
89 pub extern "C" fn OutPoint_set_index(this_ptr: &mut OutPoint, mut val: u16) {
90 unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.index = val;
92 /// Constructs a new OutPoint given each field
95 pub extern "C" fn OutPoint_new(mut txid_arg: crate::c_types::ThirtyTwoBytes, mut index_arg: u16) -> OutPoint {
96 OutPoint { inner: ObjOps::heap_alloc(nativeOutPoint {
97 txid: ::bitcoin::hash_types::Txid::from_slice(&txid_arg.data[..]).unwrap(),
101 impl Clone for OutPoint {
102 fn clone(&self) -> Self {
104 inner: if <*mut nativeOutPoint>::is_null(self.inner) { std::ptr::null_mut() } else {
105 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
111 /// Used only if an object of this type is returned as a trait impl by a method
112 pub(crate) extern "C" fn OutPoint_clone_void(this_ptr: *const c_void) -> *mut c_void {
113 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeOutPoint)).clone() })) as *mut c_void
116 /// Creates a copy of the OutPoint
117 pub extern "C" fn OutPoint_clone(orig: &OutPoint) -> OutPoint {
120 /// Checks if two OutPoints contain equal inner contents.
121 /// This ignores pointers and is_owned flags and looks at the values in fields.
122 /// Two objects with NULL inner values will be considered "equal" here.
124 pub extern "C" fn OutPoint_eq(a: &OutPoint, b: &OutPoint) -> bool {
125 if a.inner == b.inner { return true; }
126 if a.inner.is_null() || b.inner.is_null() { return false; }
127 if a.get_native_ref() == b.get_native_ref() { true } else { false }
129 /// Checks if two OutPoints contain equal inner contents.
131 pub extern "C" fn OutPoint_hash(o: &OutPoint) -> u64 {
132 if o.inner.is_null() { return 0; }
133 // Note that we'd love to use std::collections::hash_map::DefaultHasher but it's not in core
135 let mut hasher = core::hash::SipHasher::new();
136 std::hash::Hash::hash(o.get_native_ref(), &mut hasher);
137 std::hash::Hasher::finish(&hasher)
139 /// Convert an `OutPoint` to a lightning channel id.
142 pub extern "C" fn OutPoint_to_channel_id(this_arg: &OutPoint) -> crate::c_types::ThirtyTwoBytes {
143 let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.to_channel_id();
144 crate::c_types::ThirtyTwoBytes { data: ret }
148 /// Serialize the OutPoint object into a byte array which can be read by OutPoint_read
149 pub extern "C" fn OutPoint_write(obj: &OutPoint) -> crate::c_types::derived::CVec_u8Z {
150 crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
153 pub(crate) extern "C" fn OutPoint_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
154 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeOutPoint) })
157 /// Read a OutPoint from a byte array, created by OutPoint_write
158 pub extern "C" fn OutPoint_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_OutPointDecodeErrorZ {
159 let res = crate::c_types::deserialize_obj(ser);
160 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 { inner: ObjOps::heap_alloc(e), is_owned: true } }).into() };