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.
12 use bitcoin::hashes::Hash;
13 use crate::c_types::*;
16 use lightning::chain::transaction::OutPoint as nativeOutPointImport;
17 type nativeOutPoint = nativeOutPointImport;
19 /// A reference to a transaction output.
21 /// Differs from bitcoin::blockdata::transaction::OutPoint as the index is a u16 instead of u32
22 /// due to LN's restrictions on index values. Should reduce (possibly) unsafe conversions this way.
26 /// A pointer to the opaque Rust object.
28 /// Nearly everywhere, inner must be non-null, however in places where
29 /// the Rust equivalent takes an Option, it may be set to null to indicate None.
30 pub inner: *mut nativeOutPoint,
31 /// Indicates that this is the only struct which contains the same pointer.
33 /// Rust functions which take ownership of an object provided via an argument require
34 /// this to be true and invalidate the object pointed to by inner.
38 impl Drop for OutPoint {
40 if self.is_owned && !<*mut nativeOutPoint>::is_null(self.inner) {
41 let _ = unsafe { Box::from_raw(self.inner) };
45 /// Frees any resources used by the OutPoint, if is_owned is set and inner is non-NULL.
47 pub extern "C" fn OutPoint_free(this_obj: OutPoint) { }
49 /// Used only if an object of this type is returned as a trait impl by a method
50 extern "C" fn OutPoint_free_void(this_ptr: *mut c_void) {
51 unsafe { let _ = Box::from_raw(this_ptr as *mut nativeOutPoint); }
54 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
56 pub(crate) fn take_inner(mut self) -> *mut nativeOutPoint {
57 assert!(self.is_owned);
59 self.inner = std::ptr::null_mut();
63 /// The referenced transaction's txid.
65 pub extern "C" fn OutPoint_get_txid(this_ptr: &OutPoint) -> *const [u8; 32] {
66 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.txid;
67 (*inner_val).as_inner()
69 /// The referenced transaction's txid.
71 pub extern "C" fn OutPoint_set_txid(this_ptr: &mut OutPoint, mut val: crate::c_types::ThirtyTwoBytes) {
72 unsafe { &mut *this_ptr.inner }.txid = ::bitcoin::hash_types::Txid::from_slice(&val.data[..]).unwrap();
74 /// The index of the referenced output in its transaction's vout.
76 pub extern "C" fn OutPoint_get_index(this_ptr: &OutPoint) -> u16 {
77 let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.index;
80 /// The index of the referenced output in its transaction's vout.
82 pub extern "C" fn OutPoint_set_index(this_ptr: &mut OutPoint, mut val: u16) {
83 unsafe { &mut *this_ptr.inner }.index = val;
85 /// Constructs a new OutPoint given each field
88 pub extern "C" fn OutPoint_new(mut txid_arg: crate::c_types::ThirtyTwoBytes, mut index_arg: u16) -> OutPoint {
89 OutPoint { inner: Box::into_raw(Box::new(nativeOutPoint {
90 txid: ::bitcoin::hash_types::Txid::from_slice(&txid_arg.data[..]).unwrap(),
94 impl Clone for OutPoint {
95 fn clone(&self) -> Self {
97 inner: if <*mut nativeOutPoint>::is_null(self.inner) { std::ptr::null_mut() } else {
98 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
104 /// Used only if an object of this type is returned as a trait impl by a method
105 pub(crate) extern "C" fn OutPoint_clone_void(this_ptr: *const c_void) -> *mut c_void {
106 Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeOutPoint)).clone() })) as *mut c_void
109 /// Creates a copy of the OutPoint
110 pub extern "C" fn OutPoint_clone(orig: &OutPoint) -> OutPoint {
113 /// Convert an `OutPoint` to a lightning channel id.
116 pub extern "C" fn OutPoint_to_channel_id(this_arg: &OutPoint) -> crate::c_types::ThirtyTwoBytes {
117 let mut ret = unsafe { &*this_arg.inner }.to_channel_id();
118 crate::c_types::ThirtyTwoBytes { data: ret }
122 /// Serialize the OutPoint object into a byte array which can be read by OutPoint_read
123 pub extern "C" fn OutPoint_write(obj: &OutPoint) -> crate::c_types::derived::CVec_u8Z {
124 crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
127 pub(crate) extern "C" fn OutPoint_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
128 crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeOutPoint) })
131 /// Read a OutPoint from a byte array, created by OutPoint_write
132 pub extern "C" fn OutPoint_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_OutPointDecodeErrorZ {
133 let res = crate::c_types::deserialize_obj(ser);
134 let mut local_res = match res { Ok(mut o) => crate::c_types::CResultTempl::ok( { crate::chain::transaction::OutPoint { inner: Box::into_raw(Box::new(o)), is_owned: true } }).into(), Err(mut e) => crate::c_types::CResultTempl::err( { crate::ln::msgs::DecodeError { inner: Box::into_raw(Box::new(e)), is_owned: true } }).into() };