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