3 use bitcoin::Script as BitcoinScript;
4 use bitcoin::Transaction as BitcoinTransaction;
5 use bitcoin::secp256k1::key::PublicKey as SecpPublicKey;
6 use bitcoin::secp256k1::key::SecretKey as SecpSecretKey;
7 use bitcoin::secp256k1::Signature as SecpSignature;
8 use bitcoin::secp256k1::Error as SecpError;
12 pub struct PublicKey {
13 pub compressed_form: [u8; 33],
16 pub(crate) fn from_rust(pk: &SecpPublicKey) -> Self {
18 compressed_form: pk.serialize(),
21 pub(crate) fn into_rust(&self) -> SecpPublicKey {
22 SecpPublicKey::from_slice(&self.compressed_form).unwrap()
24 pub(crate) fn is_null(&self) -> bool { self.compressed_form[..] == [0; 33][..] }
25 pub(crate) fn null() -> Self { Self { compressed_form: [0; 33] } }
29 pub struct SecretKey {
33 // from_rust isn't implemented for a ref since we just return byte array refs directly
34 pub(crate) fn from_rust(sk: SecpSecretKey) -> Self {
35 let mut bytes = [0; 32];
36 bytes.copy_from_slice(&sk[..]);
39 pub(crate) fn into_rust(&self) -> SecpSecretKey {
40 SecpSecretKey::from_slice(&self.bytes).unwrap()
45 pub struct Signature {
46 pub compact_form: [u8; 64],
49 pub(crate) fn from_rust(pk: &SecpSignature) -> Self {
51 compact_form: pk.serialize_compact(),
54 pub(crate) fn into_rust(&self) -> SecpSignature {
55 SecpSignature::from_compact(&self.compact_form).unwrap()
57 pub(crate) fn is_null(&self) -> bool { self.compact_form[..] == [0; 64][..] }
58 pub(crate) fn null() -> Self { Self { compact_form: [0; 64] } }
62 pub enum Secp256k1Error {
74 pub(crate) fn from_rust(err: SecpError) -> Self {
76 SecpError::IncorrectSignature => Secp256k1Error::IncorrectSignature,
77 SecpError::InvalidMessage => Secp256k1Error::InvalidMessage,
78 SecpError::InvalidPublicKey => Secp256k1Error::InvalidPublicKey,
79 SecpError::InvalidSignature => Secp256k1Error::InvalidSignature,
80 SecpError::InvalidSecretKey => Secp256k1Error::InvalidSecretKey,
81 SecpError::InvalidRecoveryId => Secp256k1Error::InvalidRecoveryId,
82 SecpError::InvalidTweak => Secp256k1Error::InvalidTweak,
83 SecpError::NotEnoughMemory => Secp256k1Error::NotEnoughMemory,
89 /// A serialized transaction, in (pointer, length) form.
91 /// This type optionally owns its own memory, and thus the semantics around access change based on
92 /// the `data_is_owned` flag. If `data_is_owned` is set, you must call `Transaction_free` to free
93 /// the underlying buffer before the object goes out of scope. If `data_is_owned` is not set, any
94 /// access to the buffer after the scope in which the object was provided to you is invalid. eg,
95 /// access after you return from the call in which a `!data_is_owned` `Transaction` is provided to
96 /// you would be invalid.
98 /// Note that, while it may change in the future, because transactions on the Rust side are stored
99 /// in a deserialized form, all `Transaction`s generated on the Rust side will have `data_is_owned`
100 /// set. Similarly, while it may change in the future, all `Transaction`s you pass to Rust may have
101 /// `data_is_owned` either set or unset at your discretion.
102 pub struct Transaction {
103 /// This is non-const for your convenience, an object passed to Rust is never written to.
106 pub data_is_owned: bool,
109 pub(crate) fn into_bitcoin(&self) -> BitcoinTransaction {
110 if self.datalen == 0 { panic!("0-length buffer can never represent a valid Transaction"); }
111 ::bitcoin::consensus::encode::deserialize(unsafe { std::slice::from_raw_parts(self.data, self.datalen) }).unwrap()
113 pub(crate) fn from_vec(v: Vec<u8>) -> Self {
114 let datalen = v.len();
115 let data = Box::into_raw(v.into_boxed_slice());
117 data: unsafe { (*data).as_mut_ptr() },
123 impl Drop for Transaction {
125 if self.data_is_owned && self.datalen != 0 {
126 let _ = CVecTempl { data: self.data as *mut u8, datalen: self.datalen };
131 pub extern "C" fn Transaction_free(_res: Transaction) { }
135 /// A transaction output including a scriptPubKey and value.
136 /// This type *does* own its own memory, so must be free'd appropriately.
138 pub script_pubkey: derived::CVec_u8Z,
143 pub(crate) fn into_rust(mut self) -> ::bitcoin::blockdata::transaction::TxOut {
144 ::bitcoin::blockdata::transaction::TxOut {
145 script_pubkey: self.script_pubkey.into_rust().into(),
149 pub(crate) fn from_rust(txout: ::bitcoin::blockdata::transaction::TxOut) -> Self {
151 script_pubkey: CVecTempl::from(txout.script_pubkey.into_bytes()),
157 pub extern "C" fn TxOut_free(_res: TxOut) { }
165 pub(crate) fn from_slice(s: &[u8]) -> Self {
171 pub(crate) fn to_slice(&self) -> &[u8] {
172 if self.datalen == 0 { return &[]; }
173 unsafe { std::slice::from_raw_parts(self.data, self.datalen) }
178 #[derive(Copy, Clone)]
179 /// Arbitrary 32 bytes, which could represent one of a few different things. You probably want to
180 /// look up the corresponding function in rust-lightning's docs.
181 pub struct ThirtyTwoBytes {
184 impl ThirtyTwoBytes {
185 pub(crate) fn null() -> Self {
186 Self { data: [0; 32] }
191 pub struct ThreeBytes { pub data: [u8; 3], }
194 pub struct FourBytes { pub data: [u8; 4], }
197 pub struct TenBytes { pub data: [u8; 10], }
200 pub struct SixteenBytes { pub data: [u8; 16], }
202 pub(crate) struct VecWriter(pub Vec<u8>);
203 impl lightning::util::ser::Writer for VecWriter {
204 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
205 self.0.extend_from_slice(buf);
208 fn size_hint(&mut self, size: usize) {
209 self.0.reserve_exact(size);
212 pub(crate) fn serialize_obj<I: lightning::util::ser::Writeable>(i: &I) -> derived::CVec_u8Z {
213 let mut out = VecWriter(Vec::new());
214 i.write(&mut out).unwrap();
215 CVecTempl::from(out.0)
217 pub(crate) fn deserialize_obj<I: lightning::util::ser::Readable>(s: u8slice) -> Result<I, lightning::ln::msgs::DecodeError> {
218 I::read(&mut s.to_slice())
222 #[derive(Copy, Clone)]
223 /// A Rust str object, ie a reference to a UTF8-valid string.
224 /// This is *not* null-terminated so cannot be used directly as a C string!
226 pub chars: *const u8,
229 impl Into<Str> for &'static str {
230 fn into(self) -> Str {
231 Str { chars: self.as_ptr(), len: self.len() }
234 impl Into<&'static str> for Str {
235 fn into(self) -> &'static str {
236 if self.len == 0 { return ""; }
237 std::str::from_utf8(unsafe { std::slice::from_raw_parts(self.chars, self.len) }).unwrap()
241 // Note that the C++ headers memset(0) all the Templ types to avoid deallocation!
242 // Thus, they must gracefully handle being completely null in _free.
244 // TODO: Integer/bool primitives should avoid the pointer indirection for underlying types
245 // everywhere in the containers.
248 pub union CResultPtr<O, E> {
253 pub struct CResultTempl<O, E> {
254 pub contents: CResultPtr<O, E>,
257 impl<O, E> CResultTempl<O, E> {
258 pub(crate) extern "C" fn ok(o: O) -> Self {
260 contents: CResultPtr {
261 result: Box::into_raw(Box::new(o)),
266 pub(crate) extern "C" fn err(e: E) -> Self {
268 contents: CResultPtr {
269 err: Box::into_raw(Box::new(e)),
275 pub extern "C" fn CResultTempl_free<O, E>(_res: CResultTempl<O, E>) { }
276 impl<O, E> Drop for CResultTempl<O, E> {
279 if unsafe { !self.contents.result.is_null() } {
280 unsafe { Box::from_raw(self.contents.result) };
282 } else if unsafe { !self.contents.err.is_null() } {
283 unsafe { Box::from_raw(self.contents.err) };
289 pub struct CVecTempl<T> {
293 impl<T> CVecTempl<T> {
294 pub(crate) fn into_rust(&mut self) -> Vec<T> {
295 if self.datalen == 0 { return Vec::new(); }
296 let ret = unsafe { Box::from_raw(std::slice::from_raw_parts_mut(self.data, self.datalen)) }.into();
297 self.data = std::ptr::null_mut();
301 pub(crate) fn as_slice(&self) -> &[T] {
302 unsafe { std::slice::from_raw_parts_mut(self.data, self.datalen) }
305 impl<T> From<Vec<T>> for CVecTempl<T> {
306 fn from(v: Vec<T>) -> Self {
307 let datalen = v.len();
308 let data = Box::into_raw(v.into_boxed_slice());
309 CVecTempl { datalen, data: unsafe { (*data).as_mut_ptr() } }
312 pub extern "C" fn CVecTempl_free<T>(_res: CVecTempl<T>) { }
313 impl<T> Drop for CVecTempl<T> {
315 if self.datalen == 0 { return; }
316 unsafe { Box::from_raw(std::slice::from_raw_parts_mut(self.data, self.datalen)) };
319 impl<T: Clone> Clone for CVecTempl<T> {
320 fn clone(&self) -> Self {
321 let mut res = Vec::new();
322 if self.datalen == 0 { return Self::from(res); }
323 res.extend_from_slice(unsafe { std::slice::from_raw_parts_mut(self.data, self.datalen) });
329 pub struct C2TupleTempl<A, B> {
333 impl<A, B> From<(A, B)> for C2TupleTempl<A, B> {
334 fn from(tup: (A, B)) -> Self {
341 impl<A, B> C2TupleTempl<A, B> {
342 pub(crate) fn to_rust(mut self) -> (A, B) {
346 pub extern "C" fn C2TupleTempl_free<A, B>(_res: C2TupleTempl<A, B>) { }
347 impl <A: Clone, B: Clone> Clone for C2TupleTempl<A, B> {
348 fn clone(&self) -> Self {
357 pub struct C3TupleTempl<A, B, C> {
362 impl<A, B, C> From<(A, B, C)> for C3TupleTempl<A, B, C> {
363 fn from(tup: (A, B, C)) -> Self {
371 impl<A, B, C> C3TupleTempl<A, B, C> {
372 pub(crate) fn to_rust(mut self) -> (A, B, C) {
373 (self.a, self.b, self.c)
376 pub extern "C" fn C3TupleTempl_free<A, B, C>(_res: C3TupleTempl<A, B, C>) { }
378 /// Utility to make it easy to set a pointer to null and get its original value in line.
379 pub(crate) trait TakePointer<T> {
380 fn take_ptr(&mut self) -> T;
382 impl<T> TakePointer<*const T> for *const T {
383 fn take_ptr(&mut self) -> *const T {
385 *self = std::ptr::null();
389 impl<T> TakePointer<*mut T> for *mut T {
390 fn take_ptr(&mut self) -> *mut T {
392 *self = std::ptr::null_mut();