1 //! This module contains standard C-mapped types for types not in the original crate.
3 /// Auto-generated C-mapped types for templated containers
6 use bitcoin::Transaction as BitcoinTransaction;
7 use bitcoin::hashes::Hash;
8 use bitcoin::secp256k1::key::PublicKey as SecpPublicKey;
9 use bitcoin::secp256k1::key::SecretKey as SecpSecretKey;
10 use bitcoin::secp256k1::Signature as SecpSignature;
11 use bitcoin::secp256k1::Error as SecpError;
12 use bitcoin::secp256k1::recovery::RecoveryId;
13 use bitcoin::secp256k1::recovery::RecoverableSignature as SecpRecoverableSignature;
16 use std::convert::TryInto; // Bindings need at least rustc 1.34
18 /// Integer in the range `0..32`
19 #[derive(PartialEq, Eq, Copy, Clone)]
20 #[allow(non_camel_case_types)]
24 impl From<bech32::u5> for u5 {
25 fn from(o: bech32::u5) -> Self { Self(o.to_u8()) }
27 impl Into<bech32::u5> for u5 {
28 fn into(self) -> bech32::u5 { bech32::u5::try_from_u8(self.0).expect("u5 objects must be in the range 0..32") }
33 /// Represents a valid secp256k1 public key serialized in "compressed form" as a 33 byte array.
34 pub struct PublicKey {
35 /// The bytes of the public key
36 pub compressed_form: [u8; 33],
39 pub(crate) fn from_rust(pk: &SecpPublicKey) -> Self {
41 compressed_form: pk.serialize(),
44 pub(crate) fn into_rust(&self) -> SecpPublicKey {
45 SecpPublicKey::from_slice(&self.compressed_form).unwrap()
47 pub(crate) fn is_null(&self) -> bool { self.compressed_form[..] == [0; 33][..] }
48 pub(crate) fn null() -> Self { Self { compressed_form: [0; 33] } }
52 /// Represents a valid secp256k1 secret key serialized as a 32 byte array.
53 pub struct SecretKey {
54 /// The bytes of the secret key
58 // from_rust isn't implemented for a ref since we just return byte array refs directly
59 pub(crate) fn from_rust(sk: SecpSecretKey) -> Self {
60 let mut bytes = [0; 32];
61 bytes.copy_from_slice(&sk[..]);
64 pub(crate) fn into_rust(&self) -> SecpSecretKey {
65 SecpSecretKey::from_slice(&self.bytes).unwrap()
71 /// Represents a secp256k1 signature serialized as two 32-byte numbers
72 pub struct Signature {
73 /// The bytes of the signature in "compact" form
74 pub compact_form: [u8; 64],
77 pub(crate) fn from_rust(pk: &SecpSignature) -> Self {
79 compact_form: pk.serialize_compact(),
82 pub(crate) fn into_rust(&self) -> SecpSignature {
83 SecpSignature::from_compact(&self.compact_form).unwrap()
85 // The following are used for Option<Signature> which we support, but don't use anymore
86 #[allow(unused)] pub(crate) fn is_null(&self) -> bool { self.compact_form[..] == [0; 64][..] }
87 #[allow(unused)] pub(crate) fn null() -> Self { Self { compact_form: [0; 64] } }
92 /// Represents a secp256k1 signature serialized as two 32-byte numbers as well as a tag which
93 /// allows recovering the exact public key which created the signature given the message.
94 pub struct RecoverableSignature {
95 /// The bytes of the signature in "compact" form plus a "Recovery ID" which allows for
97 pub serialized_form: [u8; 68],
99 impl RecoverableSignature {
100 pub(crate) fn from_rust(pk: &SecpRecoverableSignature) -> Self {
101 let (id, compact_form) = pk.serialize_compact();
102 let mut serialized_form = [0; 68];
103 serialized_form[0..64].copy_from_slice(&compact_form[..]);
104 serialized_form[64..].copy_from_slice(&id.to_i32().to_le_bytes());
105 Self { serialized_form }
107 pub(crate) fn into_rust(&self) -> SecpRecoverableSignature {
109 id.copy_from_slice(&self.serialized_form[64..]);
110 SecpRecoverableSignature::from_compact(&self.serialized_form[0..64],
111 RecoveryId::from_i32(i32::from_le_bytes(id)).expect("Invalid Recovery ID"))
117 #[derive(Copy, Clone)]
118 /// Represents an error returned from libsecp256k1 during validation of some secp256k1 data
119 pub enum Secp256k1Error {
120 /// Signature failed verification
122 /// Badly sized message ("messages" are actually fixed-sized digests; see the MESSAGE_SIZE constant)
132 /// Invalid tweak for add_assign or mul_assign
134 /// tweak_add_check failed on an xonly public key
136 /// Didn't pass enough memory to context creation with preallocated memory
139 impl Secp256k1Error {
140 pub(crate) fn from_rust(err: SecpError) -> Self {
142 SecpError::IncorrectSignature => Secp256k1Error::IncorrectSignature,
143 SecpError::InvalidMessage => Secp256k1Error::InvalidMessage,
144 SecpError::InvalidPublicKey => Secp256k1Error::InvalidPublicKey,
145 SecpError::InvalidSignature => Secp256k1Error::InvalidSignature,
146 SecpError::InvalidSecretKey => Secp256k1Error::InvalidSecretKey,
147 SecpError::InvalidRecoveryId => Secp256k1Error::InvalidRecoveryId,
148 SecpError::InvalidTweak => Secp256k1Error::InvalidTweak,
149 SecpError::TweakCheckFailed => Secp256k1Error::TweakCheckFailed,
150 SecpError::NotEnoughMemory => Secp256k1Error::NotEnoughMemory,
156 #[allow(missing_docs)] // If there's no docs upstream, that's good enough for us
157 #[derive(Clone, Copy, PartialEq)]
158 /// Represents an IO Error. Note that some information is lost in the conversion from Rust.
180 pub(crate) fn from_rust(err: std::io::Error) -> Self {
182 std::io::ErrorKind::NotFound => IOError::NotFound,
183 std::io::ErrorKind::PermissionDenied => IOError::PermissionDenied,
184 std::io::ErrorKind::ConnectionRefused => IOError::ConnectionRefused,
185 std::io::ErrorKind::ConnectionReset => IOError::ConnectionReset,
186 std::io::ErrorKind::ConnectionAborted => IOError::ConnectionAborted,
187 std::io::ErrorKind::NotConnected => IOError::NotConnected,
188 std::io::ErrorKind::AddrInUse => IOError::AddrInUse,
189 std::io::ErrorKind::AddrNotAvailable => IOError::AddrNotAvailable,
190 std::io::ErrorKind::BrokenPipe => IOError::BrokenPipe,
191 std::io::ErrorKind::AlreadyExists => IOError::AlreadyExists,
192 std::io::ErrorKind::WouldBlock => IOError::WouldBlock,
193 std::io::ErrorKind::InvalidInput => IOError::InvalidInput,
194 std::io::ErrorKind::InvalidData => IOError::InvalidData,
195 std::io::ErrorKind::TimedOut => IOError::TimedOut,
196 std::io::ErrorKind::WriteZero => IOError::WriteZero,
197 std::io::ErrorKind::Interrupted => IOError::Interrupted,
198 std::io::ErrorKind::Other => IOError::Other,
199 std::io::ErrorKind::UnexpectedEof => IOError::UnexpectedEof,
203 pub(crate) fn to_rust(&self) -> std::io::Error {
204 std::io::Error::new(match self {
205 IOError::NotFound => std::io::ErrorKind::NotFound,
206 IOError::PermissionDenied => std::io::ErrorKind::PermissionDenied,
207 IOError::ConnectionRefused => std::io::ErrorKind::ConnectionRefused,
208 IOError::ConnectionReset => std::io::ErrorKind::ConnectionReset,
209 IOError::ConnectionAborted => std::io::ErrorKind::ConnectionAborted,
210 IOError::NotConnected => std::io::ErrorKind::NotConnected,
211 IOError::AddrInUse => std::io::ErrorKind::AddrInUse,
212 IOError::AddrNotAvailable => std::io::ErrorKind::AddrNotAvailable,
213 IOError::BrokenPipe => std::io::ErrorKind::BrokenPipe,
214 IOError::AlreadyExists => std::io::ErrorKind::AlreadyExists,
215 IOError::WouldBlock => std::io::ErrorKind::WouldBlock,
216 IOError::InvalidInput => std::io::ErrorKind::InvalidInput,
217 IOError::InvalidData => std::io::ErrorKind::InvalidData,
218 IOError::TimedOut => std::io::ErrorKind::TimedOut,
219 IOError::WriteZero => std::io::ErrorKind::WriteZero,
220 IOError::Interrupted => std::io::ErrorKind::Interrupted,
221 IOError::Other => std::io::ErrorKind::Other,
222 IOError::UnexpectedEof => std::io::ErrorKind::UnexpectedEof,
228 /// A serialized transaction, in (pointer, length) form.
230 /// This type optionally owns its own memory, and thus the semantics around access change based on
231 /// the `data_is_owned` flag. If `data_is_owned` is set, you must call `Transaction_free` to free
232 /// the underlying buffer before the object goes out of scope. If `data_is_owned` is not set, any
233 /// access to the buffer after the scope in which the object was provided to you is invalid. eg,
234 /// access after you return from the call in which a `!data_is_owned` `Transaction` is provided to
235 /// you would be invalid.
237 /// Note that, while it may change in the future, because transactions on the Rust side are stored
238 /// in a deserialized form, all `Transaction`s generated on the Rust side will have `data_is_owned`
239 /// set. Similarly, while it may change in the future, all `Transaction`s you pass to Rust may have
240 /// `data_is_owned` either set or unset at your discretion.
241 pub struct Transaction {
242 /// The serialized transaction data.
244 /// This is non-const for your convenience, an object passed to Rust is never written to.
246 /// The length of the serialized transaction
248 /// Whether the data pointed to by `data` should be freed or not.
249 pub data_is_owned: bool,
252 fn from_vec(vec: Vec<u8>) -> Self {
253 let datalen = vec.len();
254 let data = Box::into_raw(vec.into_boxed_slice());
256 data: unsafe { (*data).as_mut_ptr() },
261 pub(crate) fn into_bitcoin(&self) -> BitcoinTransaction {
262 if self.datalen == 0 { panic!("0-length buffer can never represent a valid Transaction"); }
263 ::bitcoin::consensus::encode::deserialize(unsafe { std::slice::from_raw_parts(self.data, self.datalen) }).unwrap()
265 pub(crate) fn from_bitcoin(btc: &BitcoinTransaction) -> Self {
266 let vec = ::bitcoin::consensus::encode::serialize(btc);
270 impl Drop for Transaction {
272 if self.data_is_owned && self.datalen != 0 {
273 let _ = derived::CVec_u8Z { data: self.data as *mut u8, datalen: self.datalen };
277 impl Clone for Transaction {
278 fn clone(&self) -> Self {
279 let sl = unsafe { std::slice::from_raw_parts(self.data, self.datalen) };
280 let mut v = Vec::new();
281 v.extend_from_slice(&sl);
286 /// Frees the data buffer, if data_is_owned is set and datalen > 0.
287 pub extern "C" fn Transaction_free(_res: Transaction) { }
289 pub(crate) fn bitcoin_to_C_outpoint(outpoint: ::bitcoin::blockdata::transaction::OutPoint) -> crate::lightning::chain::transaction::OutPoint {
290 crate::lightning::chain::transaction::OutPoint_new(ThirtyTwoBytes { data: outpoint.txid.into_inner() }, outpoint.vout.try_into().unwrap())
295 /// A transaction output including a scriptPubKey and value.
296 /// This type *does* own its own memory, so must be free'd appropriately.
298 /// The script_pubkey in this output
299 pub script_pubkey: derived::CVec_u8Z,
300 /// The value, in satoshis, of this output
305 pub(crate) fn into_rust(mut self) -> ::bitcoin::blockdata::transaction::TxOut {
306 ::bitcoin::blockdata::transaction::TxOut {
307 script_pubkey: self.script_pubkey.into_rust().into(),
311 pub(crate) fn from_rust(txout: ::bitcoin::blockdata::transaction::TxOut) -> Self {
313 script_pubkey: derived::CVec_u8Z::from(txout.script_pubkey.into_bytes()),
320 /// Convenience function for constructing a new TxOut
321 pub extern "C" fn TxOut_new(script_pubkey: derived::CVec_u8Z, value: u64) -> TxOut {
322 TxOut { script_pubkey, value }
325 /// Frees the data pointed to by script_pubkey.
326 pub extern "C" fn TxOut_free(_res: TxOut) { }
328 /// Creates a new TxOut which has the same data as `orig` but with a new script buffer.
329 pub extern "C" fn TxOut_clone(orig: &TxOut) -> TxOut { orig.clone() }
332 /// A "slice" referencing some byte array. This is simply a length-tagged pointer which does not
333 /// own the memory pointed to by data.
335 /// A pointer to the byte buffer
337 /// The number of bytes pointed to by `data`.
341 pub(crate) fn from_slice(s: &[u8]) -> Self {
347 pub(crate) fn to_slice(&self) -> &[u8] {
348 if self.datalen == 0 { return &[]; }
349 unsafe { std::slice::from_raw_parts(self.data, self.datalen) }
354 #[derive(Copy, Clone)]
355 /// Arbitrary 32 bytes, which could represent one of a few different things. You probably want to
356 /// look up the corresponding function in rust-lightning's docs.
357 pub struct ThirtyTwoBytes {
358 /// The thirty-two bytes
361 impl ThirtyTwoBytes {
362 pub(crate) fn null() -> Self {
363 Self { data: [0; 32] }
368 /// A 3-byte byte array.
369 pub struct ThreeBytes { /** The three bytes */ pub data: [u8; 3], }
372 /// A 4-byte byte array.
373 pub struct FourBytes { /** The four bytes */ pub data: [u8; 4], }
376 /// A 10-byte byte array.
377 pub struct TenBytes { /** The ten bytes */ pub data: [u8; 10], }
380 /// A 16-byte byte array.
381 pub struct SixteenBytes { /** The sixteen bytes */ pub data: [u8; 16], }
384 /// A 20-byte byte array.
385 pub struct TwentyBytes { /** The twenty bytes */ pub data: [u8; 20], }
387 pub(crate) struct VecWriter(pub Vec<u8>);
388 impl lightning::util::ser::Writer for VecWriter {
389 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
390 self.0.extend_from_slice(buf);
393 fn size_hint(&mut self, size: usize) {
394 self.0.reserve_exact(size);
397 pub(crate) fn serialize_obj<I: lightning::util::ser::Writeable>(i: &I) -> derived::CVec_u8Z {
398 let mut out = VecWriter(Vec::new());
399 i.write(&mut out).unwrap();
400 derived::CVec_u8Z::from(out.0)
402 pub(crate) fn deserialize_obj<I: lightning::util::ser::Readable>(s: u8slice) -> Result<I, lightning::ln::msgs::DecodeError> {
403 I::read(&mut s.to_slice())
405 pub(crate) fn deserialize_obj_arg<A, I: lightning::util::ser::ReadableArgs<A>>(s: u8slice, args: A) -> Result<I, lightning::ln::msgs::DecodeError> {
406 I::read(&mut s.to_slice(), args)
411 /// A Rust str object, ie a reference to a UTF8-valid string.
412 /// This is *not* null-terminated so cannot be used directly as a C string!
414 /// A pointer to the string's bytes, in UTF8 encoding
415 pub chars: *const u8,
416 /// The number of bytes (not characters!) pointed to by `chars`
418 /// Whether the data pointed to by `chars` should be freed or not.
419 pub chars_is_owned: bool,
421 impl Into<Str> for &'static str {
422 fn into(self) -> Str {
423 Str { chars: self.as_ptr(), len: self.len(), chars_is_owned: false }
427 pub(crate) fn into_str(&self) -> &'static str {
428 if self.len == 0 { return ""; }
429 std::str::from_utf8(unsafe { std::slice::from_raw_parts(self.chars, self.len) }).unwrap()
431 pub(crate) fn into_string(mut self) -> String {
432 let bytes = if self.len == 0 {
434 } else if self.chars_is_owned {
436 Box::from_raw(std::slice::from_raw_parts_mut(unsafe { self.chars as *mut u8 }, self.len))
438 self.chars_is_owned = false;
441 let mut ret = Vec::with_capacity(self.len);
442 ret.extend_from_slice(unsafe { std::slice::from_raw_parts(self.chars, self.len) });
445 String::from_utf8(bytes).unwrap()
448 impl Into<Str> for String {
449 fn into(self) -> Str {
450 let s = Box::leak(self.into_boxed_str());
451 Str { chars: s.as_ptr(), len: s.len(), chars_is_owned: true }
457 if self.chars_is_owned && self.len != 0 {
458 let _ = derived::CVec_u8Z { data: self.chars as *mut u8, datalen: self.len };
463 /// Frees the data buffer, if chars_is_owned is set and len > 0.
464 pub extern "C" fn Str_free(_res: Str) { }
466 // Note that the C++ headers memset(0) all the Templ types to avoid deallocation!
467 // Thus, they must gracefully handle being completely null in _free.
469 // TODO: Integer/bool primitives should avoid the pointer indirection for underlying types
470 // everywhere in the containers.
473 pub(crate) union CResultPtr<O, E> {
474 pub(crate) result: *mut O,
475 pub(crate) err: *mut E,
478 pub(crate) struct CResultTempl<O, E> {
479 pub(crate) contents: CResultPtr<O, E>,
480 pub(crate) result_ok: bool,
482 impl<O, E> CResultTempl<O, E> {
483 pub(crate) extern "C" fn ok(o: O) -> Self {
485 contents: CResultPtr {
486 result: Box::into_raw(Box::new(o)),
491 pub(crate) extern "C" fn err(e: E) -> Self {
493 contents: CResultPtr {
494 err: Box::into_raw(Box::new(e)),
500 impl<O, E> Drop for CResultTempl<O, E> {
503 if unsafe { !self.contents.result.is_null() } {
504 unsafe { Box::from_raw(self.contents.result) };
506 } else if unsafe { !self.contents.err.is_null() } {
507 unsafe { Box::from_raw(self.contents.err) };
512 /// Utility to make it easy to set a pointer to null and get its original value in line.
513 pub(crate) trait TakePointer<T> {
514 fn take_ptr(&mut self) -> T;
516 impl<T> TakePointer<*const T> for *const T {
517 fn take_ptr(&mut self) -> *const T {
519 *self = std::ptr::null();
523 impl<T> TakePointer<*mut T> for *mut T {
524 fn take_ptr(&mut self) -> *mut T {
526 *self = std::ptr::null_mut();