_ Git - rust-lightning/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         /// Nearly everywhere, inner must be non-null, however in places where
  19         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
  20         pub inner: *mut nativeOutPoint,
  21         pub is_owned: bool,
  22 }
  23
  24 impl Drop for OutPoint {
  25         fn drop(&mut self) {
  26                 if self.is_owned && !self.inner.is_null() {
  27                         let _ = unsafe { Box::from_raw(self.inner) };
  28                 }
  29         }
  30 }
  31 #[no_mangle]
  32 pub extern "C" fn OutPoint_free(this_ptr: OutPoint) { }
  33 #[allow(unused)]
  34 /// Used only if an object of this type is returned as a trait impl by a method
  35 extern "C" fn OutPoint_free_void(this_ptr: *mut c_void) {
  36         unsafe { let _ = Box::from_raw(this_ptr as *mut nativeOutPoint); }
  37 }
  38 #[allow(unused)]
  39 /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
  40 impl OutPoint {
  41         pub(crate) fn take_ptr(mut self) -> *mut nativeOutPoint {
  42                 assert!(self.is_owned);
  43                 let ret = self.inner;
  44                 self.inner = std::ptr::null_mut();
  45                 ret
  46         }
  47 }
  48 impl Clone for OutPoint {
  49         fn clone(&self) -> Self {
  50                 Self {
  51                         inner: Box::into_raw(Box::new(unsafe { &*self.inner }.clone())),
  52                         is_owned: true,
  53                 }
  54         }
  55 }
  56 #[allow(unused)]
  57 /// Used only if an object of this type is returned as a trait impl by a method
  58 pub(crate) extern "C" fn OutPoint_clone_void(this_ptr: *const c_void) -> *mut c_void {
  59         Box::into_raw(Box::new(unsafe { (*(this_ptr as *mut nativeOutPoint)).clone() })) as *mut c_void
  60 }
  61 #[no_mangle]
  62 pub extern "C" fn OutPoint_clone(orig: &OutPoint) -> OutPoint {
  63         OutPoint { inner: Box::into_raw(Box::new(unsafe { &*orig.inner }.clone())), is_owned: true }
  64 }
  65 /// The referenced transaction's txid.
  66 #[no_mangle]
  67 pub extern "C" fn OutPoint_get_txid(this_ptr: &OutPoint) -> *const [u8; 32] {
  68         let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.txid;
  69         (*inner_val).as_inner()
  70 }
  71 /// The referenced transaction's txid.
  72 #[no_mangle]
  73 pub extern "C" fn OutPoint_set_txid(this_ptr: &mut OutPoint, mut val: crate::c_types::ThirtyTwoBytes) {
  74         unsafe { &mut *this_ptr.inner }.txid = ::bitcoin::hash_types::Txid::from_slice(&val.data[..]).unwrap();
  75 }
  76 /// The index of the referenced output in its transaction's vout.
  77 #[no_mangle]
  78 pub extern "C" fn OutPoint_get_index(this_ptr: &OutPoint) -> u16 {
  79         let mut inner_val = &mut unsafe { &mut *this_ptr.inner }.index;
  80         (*inner_val)
  81 }
  82 /// The index of the referenced output in its transaction's vout.
  83 #[no_mangle]
  84 pub extern "C" fn OutPoint_set_index(this_ptr: &mut OutPoint, mut val: u16) {
  85         unsafe { &mut *this_ptr.inner }.index = val;
  86 }
  87 #[must_use]
  88 #[no_mangle]
  89 pub extern "C" fn OutPoint_new(mut txid_arg: crate::c_types::ThirtyTwoBytes, mut index_arg: u16) -> OutPoint {
  90         OutPoint { inner: Box::into_raw(Box::new(nativeOutPoint {
  91                 txid: ::bitcoin::hash_types::Txid::from_slice(&txid_arg.data[..]).unwrap(),
  92                 index: index_arg,
  93         })), is_owned: true }
  94 }
  95 /// Convert an `OutPoint` to a lightning channel id.
  96 #[must_use]
  97 #[no_mangle]
  98 pub extern "C" fn OutPoint_to_channel_id(this_arg: &OutPoint) -> crate::c_types::ThirtyTwoBytes {
  99         let mut ret = unsafe { &*this_arg.inner }.to_channel_id();
 100         crate::c_types::ThirtyTwoBytes { data: ret }
 101 }
 102
 103 #[no_mangle]
 104 pub extern "C" fn OutPoint_write(obj: *const OutPoint) -> crate::c_types::derived::CVec_u8Z {
 105         crate::c_types::serialize_obj(unsafe { &(*(*obj).inner) })
 106 }
 107 #[no_mangle]
 108 pub extern "C" fn OutPoint_read(ser: crate::c_types::u8slice) -> OutPoint {
 109         if let Ok(res) = crate::c_types::deserialize_obj(ser) {
 110                 OutPoint { inner: Box::into_raw(Box::new(res)), is_owned: true }
 111         } else {
 112                 OutPoint { inner: std::ptr::null_mut(), is_owned: true }
 113         }
 114 }