_ Git - ldk-c-bindings/blob - lightning-c-bindings/src/lightning/chain/transaction.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history and in the source files from which this was generated.
   3 //
   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.
   8
   9 //! Types describing on-chain transactions.
  10
  11 use alloc::str::FromStr;
  12 use core::ffi::c_void;
  13 use core::convert::Infallible;
  14 use bitcoin::hashes::Hash;
  15 use crate::c_types::*;
  16 #[cfg(feature="no-std")]
  17 use alloc::{vec::Vec, boxed::Box};
  18
  19
  20 use lightning::chain::transaction::OutPoint as nativeOutPointImport;
  21 pub(crate) type nativeOutPoint = nativeOutPointImport;
  22
  23 /// A reference to a transaction output.
  24 ///
  25 /// Differs from bitcoin::blockdata::transaction::OutPoint as the index is a u16 instead of u32
  26 /// due to LN's restrictions on index values. Should reduce (possibly) unsafe conversions this way.
  27 #[must_use]
  28 #[repr(C)]
  29 pub struct OutPoint {
  30         /// A pointer to the opaque Rust object.
  31
  32         /// Nearly everywhere, inner must be non-null, however in places where
  33         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
  34         pub inner: *mut nativeOutPoint,
  35         /// Indicates that this is the only struct which contains the same pointer.
  36
  37         /// Rust functions which take ownership of an object provided via an argument require
  38         /// this to be true and invalidate the object pointed to by inner.
  39         pub is_owned: bool,
  40 }
  41
  42 impl Drop for OutPoint {
  43         fn drop(&mut self) {
  44                 if self.is_owned && !<*mut nativeOutPoint>::is_null(self.inner) {
  45                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
  46                 }
  47         }
  48 }
  49 /// Frees any resources used by the OutPoint, if is_owned is set and inner is non-NULL.
  50 #[no_mangle]
  51 pub extern "C" fn OutPoint_free(this_obj: OutPoint) { }
  52 #[allow(unused)]
  53 /// Used only if an object of this type is returned as a trait impl by a method
  54 pub(crate) extern "C" fn OutPoint_free_void(this_ptr: *mut c_void) {
  55         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeOutPoint); }
  56 }
  57 #[allow(unused)]
  58 impl OutPoint {
  59         pub(crate) fn get_native_ref(&self) -> &'static nativeOutPoint {
  60                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
  61         }
  62         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativeOutPoint {
  63                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
  64         }
  65         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
  66         pub(crate) fn take_inner(mut self) -> *mut nativeOutPoint {
  67                 assert!(self.is_owned);
  68                 let ret = ObjOps::untweak_ptr(self.inner);
  69                 self.inner = core::ptr::null_mut();
  70                 ret
  71         }
  72 }
  73 /// The referenced transaction's txid.
  74 #[no_mangle]
  75 pub extern "C" fn OutPoint_get_txid(this_ptr: &OutPoint) -> *const [u8; 32] {
  76         let mut inner_val = &mut this_ptr.get_native_mut_ref().txid;
  77         inner_val.as_inner()
  78 }
  79 /// The referenced transaction's txid.
  80 #[no_mangle]
  81 pub extern "C" fn OutPoint_set_txid(this_ptr: &mut OutPoint, mut val: crate::c_types::ThirtyTwoBytes) {
  82         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.txid = ::bitcoin::hash_types::Txid::from_slice(&val.data[..]).unwrap();
  83 }
  84 /// The index of the referenced output in its transaction's vout.
  85 #[no_mangle]
  86 pub extern "C" fn OutPoint_get_index(this_ptr: &OutPoint) -> u16 {
  87         let mut inner_val = &mut this_ptr.get_native_mut_ref().index;
  88         *inner_val
  89 }
  90 /// The index of the referenced output in its transaction's vout.
  91 #[no_mangle]
  92 pub extern "C" fn OutPoint_set_index(this_ptr: &mut OutPoint, mut val: u16) {
  93         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.index = val;
  94 }
  95 /// Constructs a new OutPoint given each field
  96 #[must_use]
  97 #[no_mangle]
  98 pub extern "C" fn OutPoint_new(mut txid_arg: crate::c_types::ThirtyTwoBytes, mut index_arg: u16) -> OutPoint {
  99         OutPoint { inner: ObjOps::heap_alloc(nativeOutPoint {
 100                 txid: ::bitcoin::hash_types::Txid::from_slice(&txid_arg.data[..]).unwrap(),
 101                 index: index_arg,
 102         }), is_owned: true }
 103 }
 104 impl Clone for OutPoint {
 105         fn clone(&self) -> Self {
 106                 Self {
 107                         inner: if <*mut nativeOutPoint>::is_null(self.inner) { core::ptr::null_mut() } else {
 108                                 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
 109                         is_owned: true,
 110                 }
 111         }
 112 }
 113 #[allow(unused)]
 114 /// Used only if an object of this type is returned as a trait impl by a method
 115 pub(crate) extern "C" fn OutPoint_clone_void(this_ptr: *const c_void) -> *mut c_void {
 116         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeOutPoint)).clone() })) as *mut c_void
 117 }
 118 #[no_mangle]
 119 /// Creates a copy of the OutPoint
 120 pub extern "C" fn OutPoint_clone(orig: &OutPoint) -> OutPoint {
 121         orig.clone()
 122 }
 123 /// Checks if two OutPoints contain equal inner contents.
 124 /// This ignores pointers and is_owned flags and looks at the values in fields.
 125 /// Two objects with NULL inner values will be considered "equal" here.
 126 #[no_mangle]
 127 pub extern "C" fn OutPoint_eq(a: &OutPoint, b: &OutPoint) -> bool {
 128         if a.inner == b.inner { return true; }
 129         if a.inner.is_null() || b.inner.is_null() { return false; }
 130         if a.get_native_ref() == b.get_native_ref() { true } else { false }
 131 }
 132 /// Checks if two OutPoints contain equal inner contents.
 133 #[no_mangle]
 134 pub extern "C" fn OutPoint_hash(o: &OutPoint) -> u64 {
 135         if o.inner.is_null() { return 0; }
 136         // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
 137         #[allow(deprecated)]
 138         let mut hasher = core::hash::SipHasher::new();
 139         core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
 140         core::hash::Hasher::finish(&hasher)
 141 }
 142 /// Convert an `OutPoint` to a lightning channel id.
 143 #[must_use]
 144 #[no_mangle]
 145 pub extern "C" fn OutPoint_to_channel_id(this_arg: &OutPoint) -> crate::c_types::ThirtyTwoBytes {
 146         let mut ret = unsafe { &*ObjOps::untweak_ptr(this_arg.inner) }.to_channel_id();
 147         crate::c_types::ThirtyTwoBytes { data: ret }
 148 }
 149
 150 #[no_mangle]
 151 /// Serialize the OutPoint object into a byte array which can be read by OutPoint_read
 152 pub extern "C" fn OutPoint_write(obj: &OutPoint) -> crate::c_types::derived::CVec_u8Z {
 153         crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
 154 }
 155 #[no_mangle]
 156 pub(crate) extern "C" fn OutPoint_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
 157         crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeOutPoint) })
 158 }
 159 #[no_mangle]
 160 /// Read a OutPoint from a byte array, created by OutPoint_write
 161 pub extern "C" fn OutPoint_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_OutPointDecodeErrorZ {
 162         let res: Result<lightning::chain::transaction::OutPoint, lightning::ln::msgs::DecodeError> = crate::c_types::deserialize_obj(ser);
 163         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() };
 164         local_res
 165 }