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

   1 //! Types describing on-chain transactions.
   2
   3 use std::ffi::c_void;
   4 use bitcoin::hashes::Hash;
   5 use crate::c_types::*;
   6
   7
   8 use lightning::chain::transaction::OutPoint as nativeOutPointImport;
   9 type nativeOutPoint = nativeOutPointImport;
  10
  11 /// A reference to a transaction output.
  12 ///
  13 /// Differs from bitcoin::blockdata::transaction::OutPoint as the index is a u16 instead of u32
  14 /// due to LN's restrictions on index values. Should reduce (possibly) unsafe conversions this way.
  15 #[must_use]
  16 #[repr(C)]
  17 pub struct OutPoint {
  18         /// A pointer to the opaque Rust object.
  19
  20         /// Nearly everywhere, inner must be non-null, however in places where
  21         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
  22         pub inner: *mut nativeOutPoint,
  23         /// Indicates that this is the only struct which contains the same pointer.
  24
  25         /// Rust functions which take ownership of an object provided via an argument require
  26         /// this to be true and invalidate the object pointed to by inner.
  27         pub is_owned: bool,
  28 }
  29
  30 impl Drop for OutPoint {
  31         fn drop(&mut self) {
  32                 if self.is_owned && !<*mut nativeOutPoint>::is_null(self.inner) {
  33                         let _ = unsafe { Box::from_raw(self.inner) };
  34                 }
  35         }
  36 }
  37 /// Frees any resources used by the OutPoint, if is_owned is set and inner is non-NULL.
  38 #[no_mangle]
  39 pub extern "C" fn OutPoint_free(this_obj: OutPoint) { }
  40 #[allow(unused)]
  41 /// Used only if an object of this type is returned as a trait impl by a method
  42 extern "C" fn OutPoint_free_void(this_ptr: *mut c_void) {
  43         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeOutPoint); }
  44 }
  45 #[allow(unused)]
  46 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
  47 impl OutPoint {
  48         pub(crate) fn take_inner(mut self) -> *mut nativeOutPoint {
  49                 assert!(self.is_owned);
  50                 let ret = self.inner;
  51                 self.inner = std::ptr::null_mut();
  52                 ret
  53         }
  54 }
  55 /// The referenced transaction's txid.
  56 #[no_mangle]
  57 pub extern "C" fn OutPoint_get_txid(this_ptr: &OutPoint) -> *const [u8; 32] {
  58         let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.txid;
  59         (*inner_val).as_inner()
  60 }
  61 /// The referenced transaction's txid.
  62 #[no_mangle]
  63 pub extern "C" fn OutPoint_set_txid(this_ptr: &mut OutPoint, mut val: crate::c_types::ThirtyTwoBytes) {
  64         unsafe { &mut *this_ptr.inner }.txid = ::bitcoin::hash_types::Txid::from_slice(&val.data[..]).unwrap();
  65 }
  66 /// The index of the referenced output in its transaction's vout.
  67 #[no_mangle]
  68 pub extern "C" fn OutPoint_get_index(this_ptr: &OutPoint) -> u16 {
  69         let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.index;
  70         (*inner_val)
  71 }
  72 /// The index of the referenced output in its transaction's vout.
  73 #[no_mangle]
  74 pub extern "C" fn OutPoint_set_index(this_ptr: &mut OutPoint, mut val: u16) {
  75         unsafe { &mut *this_ptr.inner }.index = val;
  76 }
  77 /// Constructs a new OutPoint given each field
  78 #[must_use]
  79 #[no_mangle]
  80 pub extern "C" fn OutPoint_new(mut txid_arg: crate::c_types::ThirtyTwoBytes, mut index_arg: u16) -> OutPoint {
  81         OutPoint { inner: Box::into_raw(Box::new(nativeOutPoint {
  82                 txid: ::bitcoin::hash_types::Txid::from_slice(&txid_arg.data[..]).unwrap(),
  83                 index: index_arg,
  84         })), is_owned: true }
  85 }
  86 impl Clone for OutPoint {
  87         fn clone(&self) -> Self {
  88                 Self {
  89                         inner: if <*mut nativeOutPoint>::is_null(self.inner) { std::ptr::null_mut() } else {
  90                                 Box::into_raw(Box::new(unsafe { &*self.inner }.clone())) },
  91                         is_owned: true,
  92                 }
  93         }
  94 }
  95 #[allow(unused)]
  96 /// Used only if an object of this type is returned as a trait impl by a method
  97 pub(crate) extern "C" fn OutPoint_clone_void(this_ptr: *const c_void) -> *mut c_void {
  98         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeOutPoint)).clone() })) as *mut c_void
  99 }
 100 #[no_mangle]
 101 /// Creates a copy of the OutPoint
 102 pub extern "C" fn OutPoint_clone(orig: &OutPoint) -> OutPoint {
 103         orig.clone()
 104 }
 105 /// Convert an `OutPoint` to a lightning channel id.
 106 #[must_use]
 107 #[no_mangle]
 108 pub extern "C" fn OutPoint_to_channel_id(this_arg: &OutPoint) -> crate::c_types::ThirtyTwoBytes {
 109         let mut ret = unsafe { &*this_arg.inner }.to_channel_id();
 110         crate::c_types::ThirtyTwoBytes { data: ret }
 111 }
 112
 113 #[no_mangle]
 114 /// Serialize the OutPoint object into a byte array which can be read by OutPoint_read
 115 pub extern "C" fn OutPoint_write(obj: &OutPoint) -> crate::c_types::derived::CVec_u8Z {
 116         crate::c_types::serialize_obj(unsafe { &*unsafe { &*obj }.inner })
 117 }
 118 #[no_mangle]
 119 pub(crate) extern "C" fn OutPoint_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
 120         crate::c_types::serialize_obj(unsafe { &*(obj as *const nativeOutPoint) })
 121 }
 122 #[no_mangle]
 123 /// Read a OutPoint from a byte array, created by OutPoint_write
 124 pub extern "C" fn OutPoint_read(ser: crate::c_types::u8slice) -> crate::c_types::derived::CResult_OutPointDecodeErrorZ {
 125         let res = crate::c_types::deserialize_obj(ser);
 126         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() };
 127         local_res
 128 }