_ Git - rust-lightning/blob - lightning-c-bindings/src/c_types/mod.rs

   1 pub mod derived;
   2
   3 use bitcoin::Script as BitcoinScript;
   4 use bitcoin::Transaction as BitcoinTransaction;
   5 use bitcoin::hashes::Hash;
   6 use bitcoin::secp256k1::key::PublicKey as SecpPublicKey;
   7 use bitcoin::secp256k1::key::SecretKey as SecpSecretKey;
   8 use bitcoin::secp256k1::Signature as SecpSignature;
   9 use bitcoin::secp256k1::Error as SecpError;
  10
  11 use std::convert::TryInto; // Bindings need at least rustc 1.34
  12
  13 #[derive(Clone)]
  14 #[repr(C)]
  15 pub struct PublicKey {
  16         pub compressed_form: [u8; 33],
  17 }
  18 impl PublicKey {
  19         pub(crate) fn from_rust(pk: &SecpPublicKey) -> Self {
  20                 Self {
  21                         compressed_form: pk.serialize(),
  22                 }
  23         }
  24         pub(crate) fn into_rust(&self) -> SecpPublicKey {
  25                 SecpPublicKey::from_slice(&self.compressed_form).unwrap()
  26         }
  27         pub(crate) fn is_null(&self) -> bool { self.compressed_form[..] == [0; 33][..] }
  28         pub(crate) fn null() -> Self { Self { compressed_form: [0; 33] } }
  29 }
  30
  31 #[repr(C)]
  32 pub struct SecretKey {
  33         pub bytes: [u8; 32],
  34 }
  35 impl SecretKey {
  36         // from_rust isn't implemented for a ref since we just return byte array refs directly
  37         pub(crate) fn from_rust(sk: SecpSecretKey) -> Self {
  38                 let mut bytes = [0; 32];
  39                 bytes.copy_from_slice(&sk[..]);
  40                 Self { bytes }
  41         }
  42         pub(crate) fn into_rust(&self) -> SecpSecretKey {
  43                 SecpSecretKey::from_slice(&self.bytes).unwrap()
  44         }
  45 }
  46
  47 #[repr(C)]
  48 pub struct Signature {
  49         pub compact_form: [u8; 64],
  50 }
  51 impl Signature {
  52         pub(crate) fn from_rust(pk: &SecpSignature) -> Self {
  53                 Self {
  54                         compact_form: pk.serialize_compact(),
  55                 }
  56         }
  57         pub(crate) fn into_rust(&self) -> SecpSignature {
  58                 SecpSignature::from_compact(&self.compact_form).unwrap()
  59         }
  60         // The following are used for Option<Signature> which we support, but don't use anymore
  61         #[allow(unused)] pub(crate) fn is_null(&self) -> bool { self.compact_form[..] == [0; 64][..] }
  62         #[allow(unused)] pub(crate) fn null() -> Self { Self { compact_form: [0; 64] } }
  63 }
  64
  65 #[repr(C)]
  66 pub enum Secp256k1Error {
  67         IncorrectSignature,
  68         InvalidMessage,
  69         InvalidPublicKey,
  70         InvalidSignature,
  71         InvalidSecretKey,
  72         InvalidRecoveryId,
  73         InvalidTweak,
  74         TweakCheckFailed,
  75         NotEnoughMemory,
  76 }
  77 impl Secp256k1Error {
  78         pub(crate) fn from_rust(err: SecpError) -> Self {
  79                 match err {
  80                         SecpError::IncorrectSignature => Secp256k1Error::IncorrectSignature,
  81                         SecpError::InvalidMessage => Secp256k1Error::InvalidMessage,
  82                         SecpError::InvalidPublicKey => Secp256k1Error::InvalidPublicKey,
  83                         SecpError::InvalidSignature => Secp256k1Error::InvalidSignature,
  84                         SecpError::InvalidSecretKey => Secp256k1Error::InvalidSecretKey,
  85                         SecpError::InvalidRecoveryId => Secp256k1Error::InvalidRecoveryId,
  86                         SecpError::InvalidTweak => Secp256k1Error::InvalidTweak,
  87                         SecpError::TweakCheckFailed => Secp256k1Error::TweakCheckFailed,
  88                         SecpError::NotEnoughMemory => Secp256k1Error::NotEnoughMemory,
  89                 }
  90         }
  91 }
  92
  93 #[repr(C)]
  94 /// A serialized transaction, in (pointer, length) form.
  95 ///
  96 /// This type optionally owns its own memory, and thus the semantics around access change based on
  97 /// the `data_is_owned` flag. If `data_is_owned` is set, you must call `Transaction_free` to free
  98 /// the underlying buffer before the object goes out of scope. If `data_is_owned` is not set, any
  99 /// access to the buffer after the scope in which the object was provided to you is invalid. eg,
 100 /// access after you return from the call in which a `!data_is_owned` `Transaction` is provided to
 101 /// you would be invalid.
 102 ///
 103 /// Note that, while it may change in the future, because transactions on the Rust side are stored
 104 /// in a deserialized form, all `Transaction`s generated on the Rust side will have `data_is_owned`
 105 /// set. Similarly, while it may change in the future, all `Transaction`s you pass to Rust may have
 106 /// `data_is_owned` either set or unset at your discretion.
 107 pub struct Transaction {
 108         /// This is non-const for your convenience, an object passed to Rust is never written to.
 109         pub data: *mut u8,
 110         pub datalen: usize,
 111         pub data_is_owned: bool,
 112 }
 113 impl Transaction {
 114         pub(crate) fn into_bitcoin(&self) -> BitcoinTransaction {
 115                 if self.datalen == 0 { panic!("0-length buffer can never represent a valid Transaction"); }
 116                 ::bitcoin::consensus::encode::deserialize(unsafe { std::slice::from_raw_parts(self.data, self.datalen) }).unwrap()
 117         }
 118         pub(crate) fn from_vec(v: Vec<u8>) -> Self {
 119                 let datalen = v.len();
 120                 let data = Box::into_raw(v.into_boxed_slice());
 121                 Self {
 122                         data: unsafe { (*data).as_mut_ptr() },
 123                         datalen,
 124                         data_is_owned: true,
 125                 }
 126         }
 127 }
 128 impl Drop for Transaction {
 129         fn drop(&mut self) {
 130                 if self.data_is_owned && self.datalen != 0 {
 131                         let _ = derived::CVec_u8Z { data: self.data as *mut u8, datalen: self.datalen };
 132                 }
 133         }
 134 }
 135 #[no_mangle]
 136 pub extern "C" fn Transaction_free(_res: Transaction) { }
 137
 138 pub(crate) fn bitcoin_to_C_outpoint(outpoint: ::bitcoin::blockdata::transaction::OutPoint) -> crate::chain::transaction::OutPoint {
 139         crate::chain::transaction::OutPoint_new(ThirtyTwoBytes { data: outpoint.txid.into_inner() }, outpoint.vout.try_into().unwrap())
 140 }
 141
 142 #[repr(C)]
 143 #[derive(Clone)]
 144 /// A transaction output including a scriptPubKey and value.
 145 /// This type *does* own its own memory, so must be free'd appropriately.
 146 pub struct TxOut {
 147         pub script_pubkey: derived::CVec_u8Z,
 148         pub value: u64,
 149 }
 150
 151 impl TxOut {
 152         pub(crate) fn into_rust(mut self) -> ::bitcoin::blockdata::transaction::TxOut {
 153                 ::bitcoin::blockdata::transaction::TxOut {
 154                         script_pubkey: self.script_pubkey.into_rust().into(),
 155                         value: self.value,
 156                 }
 157         }
 158         pub(crate) fn from_rust(txout: ::bitcoin::blockdata::transaction::TxOut) -> Self {
 159                 Self {
 160                         script_pubkey: derived::CVec_u8Z::from(txout.script_pubkey.into_bytes()),
 161                         value: txout.value
 162                 }
 163         }
 164 }
 165 #[no_mangle]
 166 pub extern "C" fn TxOut_free(_res: TxOut) { }
 167
 168 #[repr(C)]
 169 pub struct u8slice {
 170         pub data: *const u8,
 171         pub datalen: usize
 172 }
 173 impl u8slice {
 174         pub(crate) fn from_slice(s: &[u8]) -> Self {
 175                 Self {
 176                         data: s.as_ptr(),
 177                         datalen: s.len(),
 178                 }
 179         }
 180         pub(crate) fn to_slice(&self) -> &[u8] {
 181                 if self.datalen == 0 { return &[]; }
 182                 unsafe { std::slice::from_raw_parts(self.data, self.datalen) }
 183         }
 184 }
 185
 186 #[repr(C)]
 187 #[derive(Copy, Clone)]
 188 /// Arbitrary 32 bytes, which could represent one of a few different things. You probably want to
 189 /// look up the corresponding function in rust-lightning's docs.
 190 pub struct ThirtyTwoBytes {
 191         pub data: [u8; 32],
 192 }
 193 impl ThirtyTwoBytes {
 194         pub(crate) fn null() -> Self {
 195                 Self { data: [0; 32] }
 196         }
 197 }
 198
 199 #[repr(C)]
 200 pub struct ThreeBytes { pub data: [u8; 3], }
 201 #[derive(Clone)]
 202 #[repr(C)]
 203 pub struct FourBytes { pub data: [u8; 4], }
 204 #[derive(Clone)]
 205 #[repr(C)]
 206 pub struct TenBytes { pub data: [u8; 10], }
 207 #[derive(Clone)]
 208 #[repr(C)]
 209 pub struct SixteenBytes { pub data: [u8; 16], }
 210
 211 pub(crate) struct VecWriter(pub Vec<u8>);
 212 impl lightning::util::ser::Writer for VecWriter {
 213         fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
 214                 self.0.extend_from_slice(buf);
 215                 Ok(())
 216         }
 217         fn size_hint(&mut self, size: usize) {
 218                 self.0.reserve_exact(size);
 219         }
 220 }
 221 pub(crate) fn serialize_obj<I: lightning::util::ser::Writeable>(i: &I) -> derived::CVec_u8Z {
 222         let mut out = VecWriter(Vec::new());
 223         i.write(&mut out).unwrap();
 224         derived::CVec_u8Z::from(out.0)
 225 }
 226 pub(crate) fn deserialize_obj<I: lightning::util::ser::Readable>(s: u8slice) -> Result<I, lightning::ln::msgs::DecodeError> {
 227         I::read(&mut s.to_slice())
 228 }
 229 pub(crate) fn deserialize_obj_arg<A, I: lightning::util::ser::ReadableArgs<A>>(s: u8slice, args: A) -> Result<I, lightning::ln::msgs::DecodeError> {
 230         I::read(&mut s.to_slice(), args)
 231 }
 232
 233 #[repr(C)]
 234 #[derive(Copy, Clone)]
 235 /// A Rust str object, ie a reference to a UTF8-valid string.
 236 /// This is *not* null-terminated so cannot be used directly as a C string!
 237 pub struct Str {
 238         pub chars: *const u8,
 239         pub len: usize
 240 }
 241 impl Into<Str> for &'static str {
 242         fn into(self) -> Str {
 243                 Str { chars: self.as_ptr(), len: self.len() }
 244         }
 245 }
 246 impl Into<&'static str> for Str {
 247         fn into(self) -> &'static str {
 248                 if self.len == 0 { return ""; }
 249                 std::str::from_utf8(unsafe { std::slice::from_raw_parts(self.chars, self.len) }).unwrap()
 250         }
 251 }
 252
 253 // Note that the C++ headers memset(0) all the Templ types to avoid deallocation!
 254 // Thus, they must gracefully handle being completely null in _free.
 255
 256 // TODO: Integer/bool primitives should avoid the pointer indirection for underlying types
 257 // everywhere in the containers.
 258
 259 #[repr(C)]
 260 pub(crate) union CResultPtr<O, E> {
 261         pub(crate) result: *mut O,
 262         pub(crate) err: *mut E,
 263 }
 264 #[repr(C)]
 265 pub(crate) struct CResultTempl<O, E> {
 266         pub(crate) contents: CResultPtr<O, E>,
 267         pub(crate) result_ok: bool,
 268 }
 269 impl<O, E> CResultTempl<O, E> {
 270         pub(crate) extern "C" fn ok(o: O) -> Self {
 271                 CResultTempl {
 272                         contents: CResultPtr {
 273                                 result: Box::into_raw(Box::new(o)),
 274                         },
 275                         result_ok: true,
 276                 }
 277         }
 278         pub(crate) extern "C" fn err(e: E) -> Self {
 279                 CResultTempl {
 280                         contents: CResultPtr {
 281                                 err: Box::into_raw(Box::new(e)),
 282                         },
 283                         result_ok: false,
 284                 }
 285         }
 286 }
 287 impl<O, E> Drop for CResultTempl<O, E> {
 288         fn drop(&mut self) {
 289                 if self.result_ok {
 290                         if unsafe { !self.contents.result.is_null() } {
 291                                 unsafe { Box::from_raw(self.contents.result) };
 292                         }
 293                 } else if unsafe { !self.contents.err.is_null() } {
 294                         unsafe { Box::from_raw(self.contents.err) };
 295                 }
 296         }
 297 }
 298
 299 /// Utility to make it easy to set a pointer to null and get its original value in line.
 300 pub(crate) trait TakePointer<T> {
 301         fn take_ptr(&mut self) -> T;
 302 }
 303 impl<T> TakePointer<*const T> for *const T {
 304         fn take_ptr(&mut self) -> *const T {
 305                 let ret = *self;
 306                 *self = std::ptr::null();
 307                 ret
 308         }
 309 }
 310 impl<T> TakePointer<*mut T> for *mut T {
 311         fn take_ptr(&mut self) -> *mut T {
 312                 let ret = *self;
 313                 *self = std::ptr::null_mut();
 314                 ret
 315         }
 316 }