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 reference to a serialized transaction, in (pointer, length) form.
90 /// This type does *not* own its own memory, so access to it after, eg, the call in which it was
91 /// provided to you are invalid.
92 pub struct Transaction {
97 pub(crate) fn into_bitcoin(&self) -> BitcoinTransaction {
98 if self.datalen == 0 { panic!("0-length buffer can never represent a valid Transaction"); }
99 ::bitcoin::consensus::encode::deserialize(unsafe { std::slice::from_raw_parts(self.data, self.datalen) }).unwrap()
101 pub(crate) fn from_slice(s: &[u8]) -> Self {
111 /// A transaction output including a scriptPubKey and value.
112 /// This type *does* own its own memory, so must be free'd appropriately.
114 pub script_pubkey: derived::CVec_u8Z,
119 pub(crate) fn into_rust(mut self) -> ::bitcoin::blockdata::transaction::TxOut {
120 ::bitcoin::blockdata::transaction::TxOut {
121 script_pubkey: self.script_pubkey.into_rust().into(),
125 pub(crate) fn from_rust(txout: ::bitcoin::blockdata::transaction::TxOut) -> Self {
127 script_pubkey: CVecTempl::from(txout.script_pubkey.into_bytes()),
133 pub extern "C" fn TxOut_free(_res: TxOut) { }
141 pub(crate) fn from_slice(s: &[u8]) -> Self {
147 pub(crate) fn to_slice(&self) -> &[u8] {
148 if self.datalen == 0 { return &[]; }
149 unsafe { std::slice::from_raw_parts(self.data, self.datalen) }
154 pub struct usizeslice {
155 pub data: *const usize,
159 pub(crate) fn from_slice(s: &[usize]) -> Self {
165 pub(crate) fn to_slice(&self) -> &[usize] {
166 if self.datalen == 0 { return &[]; }
167 unsafe { std::slice::from_raw_parts(self.data, self.datalen) }
172 #[derive(Copy, Clone)]
173 /// Arbitrary 32 bytes, which could represent one of a few different things. You probably want to
174 /// look up the corresponding function in rust-lightning's docs.
175 pub struct ThirtyTwoBytes {
178 impl ThirtyTwoBytes {
179 pub(crate) fn null() -> Self {
180 Self { data: [0; 32] }
185 pub struct ThreeBytes { pub data: [u8; 3], }
188 pub struct FourBytes { pub data: [u8; 4], }
191 pub struct TenBytes { pub data: [u8; 10], }
194 pub struct SixteenBytes { pub data: [u8; 16], }
196 pub(crate) struct VecWriter(pub Vec<u8>);
197 impl lightning::util::ser::Writer for VecWriter {
198 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
199 self.0.extend_from_slice(buf);
202 fn size_hint(&mut self, size: usize) {
203 self.0.reserve_exact(size);
206 pub(crate) fn serialize_obj<I: lightning::util::ser::Writeable>(i: &I) -> derived::CVec_u8Z {
207 let mut out = VecWriter(Vec::new());
208 i.write(&mut out).unwrap();
209 CVecTempl::from(out.0)
211 pub(crate) fn deserialize_obj<I: lightning::util::ser::Readable>(s: u8slice) -> Result<I, lightning::ln::msgs::DecodeError> {
212 I::read(&mut s.to_slice())
216 #[derive(Copy, Clone)]
217 /// A Rust str object, ie a reference to a UTF8-valid string.
218 /// This is *not* null-terminated so cannot be used directly as a C string!
220 pub chars: *const u8,
223 impl Into<Str> for &'static str {
224 fn into(self) -> Str {
225 Str { chars: self.as_ptr(), len: self.len() }
228 impl Into<&'static str> for Str {
229 fn into(self) -> &'static str {
230 if self.len == 0 { return ""; }
231 std::str::from_utf8(unsafe { std::slice::from_raw_parts(self.chars, self.len) }).unwrap()
235 // Note that the C++ headers memset(0) all the Templ types to avoid deallocation!
236 // Thus, they must gracefully handle being completely null in _free.
238 // TODO: Integer/bool primitives should avoid the pointer indirection for underlying types
239 // everywhere in the containers.
242 pub union CResultPtr<O, E> {
247 pub struct CResultTempl<O, E> {
248 pub contents: CResultPtr<O, E>,
251 impl<O, E> CResultTempl<O, E> {
252 pub(crate) extern "C" fn ok(o: O) -> Self {
254 contents: CResultPtr {
255 result: Box::into_raw(Box::new(o)),
260 pub(crate) extern "C" fn err(e: E) -> Self {
262 contents: CResultPtr {
263 err: Box::into_raw(Box::new(e)),
269 pub extern "C" fn CResultTempl_free<O, E>(_res: CResultTempl<O, E>) { }
270 impl<O, E> Drop for CResultTempl<O, E> {
273 if unsafe { !self.contents.result.is_null() } {
274 unsafe { Box::from_raw(self.contents.result) };
276 } else if unsafe { !self.contents.err.is_null() } {
277 unsafe { Box::from_raw(self.contents.err) };
283 pub struct CVecTempl<T> {
287 impl<T> CVecTempl<T> {
288 pub(crate) fn into_rust(&mut self) -> Vec<T> {
289 if self.datalen == 0 { return Vec::new(); }
290 let ret = unsafe { Box::from_raw(std::slice::from_raw_parts_mut(self.data, self.datalen)) }.into();
291 self.data = std::ptr::null_mut();
295 pub(crate) fn as_slice(&self) -> &[T] {
296 unsafe { std::slice::from_raw_parts_mut(self.data, self.datalen) }
299 impl<T> From<Vec<T>> for CVecTempl<T> {
300 fn from(v: Vec<T>) -> Self {
301 let datalen = v.len();
302 let data = Box::into_raw(v.into_boxed_slice());
303 CVecTempl { datalen, data: unsafe { (*data).as_mut_ptr() } }
306 pub extern "C" fn CVecTempl_free<T>(_res: CVecTempl<T>) { }
307 impl<T> Drop for CVecTempl<T> {
309 if self.datalen == 0 { return; }
310 unsafe { Box::from_raw(std::slice::from_raw_parts_mut(self.data, self.datalen)) };
313 impl<T: Clone> Clone for CVecTempl<T> {
314 fn clone(&self) -> Self {
315 let mut res = Vec::new();
316 if self.datalen == 0 { return Self::from(res); }
317 res.clone_from_slice(unsafe { std::slice::from_raw_parts_mut(self.data, self.datalen) });
323 pub struct C2TupleTempl<A, B> {
327 impl<A, B> From<(A, B)> for C2TupleTempl<A, B> {
328 fn from(tup: (A, B)) -> Self {
330 a: Box::into_raw(Box::new(tup.0)),
331 b: Box::into_raw(Box::new(tup.1)),
335 impl<A, B> C2TupleTempl<A, B> {
336 pub(crate) fn to_rust(mut self) -> (A, B) {
337 let res = (unsafe { *Box::from_raw(self.a) }, unsafe { *Box::from_raw(self.b) });
338 self.a = std::ptr::null_mut();
339 self.b = std::ptr::null_mut();
343 pub extern "C" fn C2TupleTempl_free<A, B>(_res: C2TupleTempl<A, B>) { }
344 impl<A, B> Drop for C2TupleTempl<A, B> {
346 if !self.a.is_null() {
347 unsafe { Box::from_raw(self.a) };
349 if !self.b.is_null() {
350 unsafe { Box::from_raw(self.b) };
354 impl <A: Clone, B: Clone> Clone for C2TupleTempl<A, B> {
355 fn clone(&self) -> Self {
357 a: Box::into_raw(Box::new(unsafe { &*self.a }.clone())),
358 b: Box::into_raw(Box::new(unsafe { &*self.b }.clone()))
364 pub struct C3TupleTempl<A, B, C> {
369 impl<A, B, C> From<(A, B, C)> for C3TupleTempl<A, B, C> {
370 fn from(tup: (A, B, C)) -> Self {
372 a: Box::into_raw(Box::new(tup.0)),
373 b: Box::into_raw(Box::new(tup.1)),
374 c: Box::into_raw(Box::new(tup.2)),
378 impl<A, B, C> C3TupleTempl<A, B, C> {
379 pub(crate) fn to_rust(mut self) -> (A, B, C) {
380 let res = (unsafe { *Box::from_raw(self.a) }, unsafe { *Box::from_raw(self.b) }, unsafe { *Box::from_raw(self.c) });
381 self.a = std::ptr::null_mut();
382 self.b = std::ptr::null_mut();
383 self.c = std::ptr::null_mut();
387 pub extern "C" fn C3TupleTempl_free<A, B, C>(_res: C3TupleTempl<A, B, C>) { }
388 impl<A, B, C> Drop for C3TupleTempl<A, B, C> {
390 if !self.a.is_null() {
391 unsafe { Box::from_raw(self.a) };
393 if !self.b.is_null() {
394 unsafe { Box::from_raw(self.b) };
396 if !self.c.is_null() {
397 unsafe { Box::from_raw(self.c) };
402 /// Utility to make it easy to set a pointer to null and get its original value in line.
403 pub(crate) trait TakePointer<T> {
404 fn take_ptr(&mut self) -> T;
406 impl<T> TakePointer<*const T> for *const T {
407 fn take_ptr(&mut self) -> *const T {
409 *self = std::ptr::null();
413 impl<T> TakePointer<*mut T> for *mut T {
414 fn take_ptr(&mut self) -> *mut T {
416 *self = std::ptr::null_mut();