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;
11 use std::convert::TryInto; // Bindings need at least rustc 1.34
15 pub struct PublicKey {
16 pub compressed_form: [u8; 33],
19 pub(crate) fn from_rust(pk: &SecpPublicKey) -> Self {
21 compressed_form: pk.serialize(),
24 pub(crate) fn into_rust(&self) -> SecpPublicKey {
25 SecpPublicKey::from_slice(&self.compressed_form).unwrap()
27 pub(crate) fn is_null(&self) -> bool { self.compressed_form[..] == [0; 33][..] }
28 pub(crate) fn null() -> Self { Self { compressed_form: [0; 33] } }
32 pub struct 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[..]);
42 pub(crate) fn into_rust(&self) -> SecpSecretKey {
43 SecpSecretKey::from_slice(&self.bytes).unwrap()
48 pub struct Signature {
49 pub compact_form: [u8; 64],
52 pub(crate) fn from_rust(pk: &SecpSignature) -> Self {
54 compact_form: pk.serialize_compact(),
57 pub(crate) fn into_rust(&self) -> SecpSignature {
58 SecpSignature::from_compact(&self.compact_form).unwrap()
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] } }
66 pub enum Secp256k1Error {
78 pub(crate) fn from_rust(err: SecpError) -> Self {
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::NotEnoughMemory => Secp256k1Error::NotEnoughMemory,
93 /// A serialized transaction, in (pointer, length) form.
95 /// This type optionally owns its own memory, and thus the semantics around access change based on
96 /// the `data_is_owned` flag. If `data_is_owned` is set, you must call `Transaction_free` to free
97 /// the underlying buffer before the object goes out of scope. If `data_is_owned` is not set, any
98 /// access to the buffer after the scope in which the object was provided to you is invalid. eg,
99 /// access after you return from the call in which a `!data_is_owned` `Transaction` is provided to
100 /// you would be invalid.
102 /// Note that, while it may change in the future, because transactions on the Rust side are stored
103 /// in a deserialized form, all `Transaction`s generated on the Rust side will have `data_is_owned`
104 /// set. Similarly, while it may change in the future, all `Transaction`s you pass to Rust may have
105 /// `data_is_owned` either set or unset at your discretion.
106 pub struct Transaction {
107 /// This is non-const for your convenience, an object passed to Rust is never written to.
110 pub data_is_owned: bool,
113 pub(crate) fn into_bitcoin(&self) -> BitcoinTransaction {
114 if self.datalen == 0 { panic!("0-length buffer can never represent a valid Transaction"); }
115 ::bitcoin::consensus::encode::deserialize(unsafe { std::slice::from_raw_parts(self.data, self.datalen) }).unwrap()
117 pub(crate) fn from_vec(v: Vec<u8>) -> Self {
118 let datalen = v.len();
119 let data = Box::into_raw(v.into_boxed_slice());
121 data: unsafe { (*data).as_mut_ptr() },
127 impl Drop for Transaction {
129 if self.data_is_owned && self.datalen != 0 {
130 let _ = CVecTempl { data: self.data as *mut u8, datalen: self.datalen };
135 pub extern "C" fn Transaction_free(_res: Transaction) { }
137 pub(crate) fn bitcoin_to_C_outpoint(outpoint: ::bitcoin::blockdata::transaction::OutPoint) -> crate::chain::transaction::OutPoint {
138 crate::chain::transaction::OutPoint_new(ThirtyTwoBytes { data: outpoint.txid.into_inner() }, outpoint.vout.try_into().unwrap())
143 /// A transaction output including a scriptPubKey and value.
144 /// This type *does* own its own memory, so must be free'd appropriately.
146 pub script_pubkey: derived::CVec_u8Z,
151 pub(crate) fn into_rust(mut self) -> ::bitcoin::blockdata::transaction::TxOut {
152 ::bitcoin::blockdata::transaction::TxOut {
153 script_pubkey: self.script_pubkey.into_rust().into(),
157 pub(crate) fn from_rust(txout: ::bitcoin::blockdata::transaction::TxOut) -> Self {
159 script_pubkey: CVecTempl::from(txout.script_pubkey.into_bytes()),
165 pub extern "C" fn TxOut_free(_res: TxOut) { }
173 pub(crate) fn from_slice(s: &[u8]) -> Self {
179 pub(crate) fn to_slice(&self) -> &[u8] {
180 if self.datalen == 0 { return &[]; }
181 unsafe { std::slice::from_raw_parts(self.data, self.datalen) }
186 #[derive(Copy, Clone)]
187 /// Arbitrary 32 bytes, which could represent one of a few different things. You probably want to
188 /// look up the corresponding function in rust-lightning's docs.
189 pub struct ThirtyTwoBytes {
192 impl ThirtyTwoBytes {
193 pub(crate) fn null() -> Self {
194 Self { data: [0; 32] }
199 pub struct ThreeBytes { pub data: [u8; 3], }
202 pub struct FourBytes { pub data: [u8; 4], }
205 pub struct TenBytes { pub data: [u8; 10], }
208 pub struct SixteenBytes { pub data: [u8; 16], }
210 pub(crate) struct VecWriter(pub Vec<u8>);
211 impl lightning::util::ser::Writer for VecWriter {
212 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
213 self.0.extend_from_slice(buf);
216 fn size_hint(&mut self, size: usize) {
217 self.0.reserve_exact(size);
220 pub(crate) fn serialize_obj<I: lightning::util::ser::Writeable>(i: &I) -> derived::CVec_u8Z {
221 let mut out = VecWriter(Vec::new());
222 i.write(&mut out).unwrap();
223 CVecTempl::from(out.0)
225 pub(crate) fn deserialize_obj<I: lightning::util::ser::Readable>(s: u8slice) -> Result<I, lightning::ln::msgs::DecodeError> {
226 I::read(&mut s.to_slice())
230 #[derive(Copy, Clone)]
231 /// A Rust str object, ie a reference to a UTF8-valid string.
232 /// This is *not* null-terminated so cannot be used directly as a C string!
234 pub chars: *const u8,
237 impl Into<Str> for &'static str {
238 fn into(self) -> Str {
239 Str { chars: self.as_ptr(), len: self.len() }
242 impl Into<&'static str> for Str {
243 fn into(self) -> &'static str {
244 if self.len == 0 { return ""; }
245 std::str::from_utf8(unsafe { std::slice::from_raw_parts(self.chars, self.len) }).unwrap()
249 // Note that the C++ headers memset(0) all the Templ types to avoid deallocation!
250 // Thus, they must gracefully handle being completely null in _free.
252 // TODO: Integer/bool primitives should avoid the pointer indirection for underlying types
253 // everywhere in the containers.
256 pub union CResultPtr<O, E> {
261 pub struct CResultTempl<O, E> {
262 pub contents: CResultPtr<O, E>,
265 impl<O, E> CResultTempl<O, E> {
266 pub(crate) extern "C" fn ok(o: O) -> Self {
268 contents: CResultPtr {
269 result: Box::into_raw(Box::new(o)),
274 pub(crate) extern "C" fn err(e: E) -> Self {
276 contents: CResultPtr {
277 err: Box::into_raw(Box::new(e)),
283 pub extern "C" fn CResultTempl_free<O, E>(_res: CResultTempl<O, E>) { }
284 impl<O, E> Drop for CResultTempl<O, E> {
287 if unsafe { !self.contents.result.is_null() } {
288 unsafe { Box::from_raw(self.contents.result) };
290 } else if unsafe { !self.contents.err.is_null() } {
291 unsafe { Box::from_raw(self.contents.err) };
297 pub struct CVecTempl<T> {
301 impl<T> CVecTempl<T> {
302 pub(crate) fn into_rust(&mut self) -> Vec<T> {
303 if self.datalen == 0 { return Vec::new(); }
304 let ret = unsafe { Box::from_raw(std::slice::from_raw_parts_mut(self.data, self.datalen)) }.into();
305 self.data = std::ptr::null_mut();
309 pub(crate) fn as_slice(&self) -> &[T] {
310 unsafe { std::slice::from_raw_parts_mut(self.data, self.datalen) }
313 impl<T> From<Vec<T>> for CVecTempl<T> {
314 fn from(v: Vec<T>) -> Self {
315 let datalen = v.len();
316 let data = Box::into_raw(v.into_boxed_slice());
317 CVecTempl { datalen, data: unsafe { (*data).as_mut_ptr() } }
320 pub extern "C" fn CVecTempl_free<T>(_res: CVecTempl<T>) { }
321 impl<T> Drop for CVecTempl<T> {
323 if self.datalen == 0 { return; }
324 unsafe { Box::from_raw(std::slice::from_raw_parts_mut(self.data, self.datalen)) };
327 impl<T: Clone> Clone for CVecTempl<T> {
328 fn clone(&self) -> Self {
329 let mut res = Vec::new();
330 if self.datalen == 0 { return Self::from(res); }
331 res.extend_from_slice(unsafe { std::slice::from_raw_parts_mut(self.data, self.datalen) });
337 pub struct C2TupleTempl<A, B> {
341 impl<A, B> From<(A, B)> for C2TupleTempl<A, B> {
342 fn from(tup: (A, B)) -> Self {
349 impl<A, B> C2TupleTempl<A, B> {
350 pub(crate) fn to_rust(mut self) -> (A, B) {
354 pub extern "C" fn C2TupleTempl_free<A, B>(_res: C2TupleTempl<A, B>) { }
355 impl <A: Clone, B: Clone> Clone for C2TupleTempl<A, B> {
356 fn clone(&self) -> Self {
365 pub struct C3TupleTempl<A, B, C> {
370 impl<A, B, C> From<(A, B, C)> for C3TupleTempl<A, B, C> {
371 fn from(tup: (A, B, C)) -> Self {
379 impl<A, B, C> C3TupleTempl<A, B, C> {
380 pub(crate) fn to_rust(mut self) -> (A, B, C) {
381 (self.a, self.b, self.c)
384 pub extern "C" fn C3TupleTempl_free<A, B, C>(_res: C3TupleTempl<A, B, C>) { }
386 /// Utility to make it easy to set a pointer to null and get its original value in line.
387 pub(crate) trait TakePointer<T> {
388 fn take_ptr(&mut self) -> T;
390 impl<T> TakePointer<*const T> for *const T {
391 fn take_ptr(&mut self) -> *const T {
393 *self = std::ptr::null();
397 impl<T> TakePointer<*mut T> for *mut T {
398 fn take_ptr(&mut self) -> *mut T {
400 *self = std::ptr::null_mut();