use bitcoin::secp256k1::key::SecretKey as SecpSecretKey;
use bitcoin::secp256k1::Signature as SecpSignature;
use bitcoin::secp256k1::Error as SecpError;
+use bitcoin::secp256k1::recovery::RecoveryId;
+use bitcoin::secp256k1::recovery::RecoverableSignature as SecpRecoverableSignature;
+use bitcoin::bech32;
use std::convert::TryInto; // Bindings need at least rustc 1.34
+/// Integer in the range `0..32`
+#[derive(PartialEq, Eq, Copy, Clone)]
+#[allow(non_camel_case_types)]
+#[repr(C)]
+pub struct u5(u8);
+
+impl From<bech32::u5> for u5 {
+ fn from(o: bech32::u5) -> Self { Self(o.to_u8()) }
+}
+impl Into<bech32::u5> for u5 {
+ fn into(self) -> bech32::u5 { bech32::u5::try_from_u8(self.0).expect("u5 objects must be in the range 0..32") }
+}
+
#[derive(Clone)]
#[repr(C)]
/// Represents a valid secp256k1 public key serialized in "compressed form" as a 33 byte array.
}
#[repr(C)]
+#[derive(Clone)]
+/// Represents a secp256k1 signature serialized as two 32-byte numbers as well as a tag which
+/// allows recovering the exact public key which created the signature given the message.
+pub struct RecoverableSignature {
+ /// The bytes of the signature in "compact" form plus a "Recovery ID" which allows for
+ /// recovery.
+ pub serialized_form: [u8; 68],
+}
+impl RecoverableSignature {
+ pub(crate) fn from_rust(pk: &SecpRecoverableSignature) -> Self {
+ let (id, compact_form) = pk.serialize_compact();
+ let mut serialized_form = [0; 68];
+ serialized_form[0..64].copy_from_slice(&compact_form[..]);
+ serialized_form[64..].copy_from_slice(&id.to_i32().to_le_bytes());
+ Self { serialized_form }
+ }
+ pub(crate) fn into_rust(&self) -> SecpRecoverableSignature {
+ let mut id = [0; 4];
+ id.copy_from_slice(&self.serialized_form[64..]);
+ SecpRecoverableSignature::from_compact(&self.serialized_form[0..64],
+ RecoveryId::from_i32(i32::from_le_bytes(id)).expect("Invalid Recovery ID"))
+ .unwrap()
+ }
+}
+
+#[repr(C)]
+#[derive(Copy, Clone)]
/// Represents an error returned from libsecp256k1 during validation of some secp256k1 data
pub enum Secp256k1Error {
/// Signature failed verification
#[repr(C)]
#[allow(missing_docs)] // If there's no docs upstream, that's good enough for us
+#[derive(Clone, Copy, PartialEq)]
/// Represents an IO Error. Note that some information is lost in the conversion from Rust.
pub enum IOError {
NotFound,
_ => IOError::Other,
}
}
+ pub(crate) fn to_rust(&self) -> std::io::Error {
+ std::io::Error::new(match self {
+ IOError::NotFound => std::io::ErrorKind::NotFound,
+ IOError::PermissionDenied => std::io::ErrorKind::PermissionDenied,
+ IOError::ConnectionRefused => std::io::ErrorKind::ConnectionRefused,
+ IOError::ConnectionReset => std::io::ErrorKind::ConnectionReset,
+ IOError::ConnectionAborted => std::io::ErrorKind::ConnectionAborted,
+ IOError::NotConnected => std::io::ErrorKind::NotConnected,
+ IOError::AddrInUse => std::io::ErrorKind::AddrInUse,
+ IOError::AddrNotAvailable => std::io::ErrorKind::AddrNotAvailable,
+ IOError::BrokenPipe => std::io::ErrorKind::BrokenPipe,
+ IOError::AlreadyExists => std::io::ErrorKind::AlreadyExists,
+ IOError::WouldBlock => std::io::ErrorKind::WouldBlock,
+ IOError::InvalidInput => std::io::ErrorKind::InvalidInput,
+ IOError::InvalidData => std::io::ErrorKind::InvalidData,
+ IOError::TimedOut => std::io::ErrorKind::TimedOut,
+ IOError::WriteZero => std::io::ErrorKind::WriteZero,
+ IOError::Interrupted => std::io::ErrorKind::Interrupted,
+ IOError::Other => std::io::ErrorKind::Other,
+ IOError::UnexpectedEof => std::io::ErrorKind::UnexpectedEof,
+ }, "")
+ }
}
#[repr(C)]
pub data_is_owned: bool,
}
impl Transaction {
- pub(crate) fn into_bitcoin(&self) -> BitcoinTransaction {
- if self.datalen == 0 { panic!("0-length buffer can never represent a valid Transaction"); }
- ::bitcoin::consensus::encode::deserialize(unsafe { std::slice::from_raw_parts(self.data, self.datalen) }).unwrap()
- }
- pub(crate) fn from_bitcoin(btc: &BitcoinTransaction) -> Self {
- let vec = ::bitcoin::consensus::encode::serialize(btc);
+ fn from_vec(vec: Vec<u8>) -> Self {
let datalen = vec.len();
let data = Box::into_raw(vec.into_boxed_slice());
Self {
data_is_owned: true,
}
}
+ pub(crate) fn into_bitcoin(&self) -> BitcoinTransaction {
+ if self.datalen == 0 { panic!("0-length buffer can never represent a valid Transaction"); }
+ ::bitcoin::consensus::encode::deserialize(unsafe { std::slice::from_raw_parts(self.data, self.datalen) }).unwrap()
+ }
+ pub(crate) fn from_bitcoin(btc: &BitcoinTransaction) -> Self {
+ let vec = ::bitcoin::consensus::encode::serialize(btc);
+ Self::from_vec(vec)
+ }
}
impl Drop for Transaction {
fn drop(&mut self) {
}
}
}
+impl Clone for Transaction {
+ fn clone(&self) -> Self {
+ let sl = unsafe { std::slice::from_raw_parts(self.data, self.datalen) };
+ let mut v = Vec::new();
+ v.extend_from_slice(&sl);
+ Self::from_vec(v)
+ }
+}
#[no_mangle]
/// Frees the data buffer, if data_is_owned is set and datalen > 0.
pub extern "C" fn Transaction_free(_res: Transaction) { }
}
}
}
+
+#[no_mangle]
+/// Convenience function for constructing a new TxOut
+pub extern "C" fn TxOut_new(script_pubkey: derived::CVec_u8Z, value: u64) -> TxOut {
+ TxOut { script_pubkey, value }
+}
#[no_mangle]
/// Frees the data pointed to by script_pubkey.
pub extern "C" fn TxOut_free(_res: TxOut) { }
#[repr(C)]
/// A 16-byte byte array.
pub struct SixteenBytes { /** The sixteen bytes */ pub data: [u8; 16], }
+#[derive(Clone)]
+#[repr(C)]
+/// A 20-byte byte array.
+pub struct TwentyBytes { /** The twenty bytes */ pub data: [u8; 20], }
pub(crate) struct VecWriter(pub Vec<u8>);
impl lightning::util::ser::Writer for VecWriter {
}
#[repr(C)]
-#[derive(Copy, Clone)]
+#[derive(Clone)]
/// A Rust str object, ie a reference to a UTF8-valid string.
/// This is *not* null-terminated so cannot be used directly as a C string!
pub struct Str {
/// A pointer to the string's bytes, in UTF8 encoding
pub chars: *const u8,
/// The number of bytes (not characters!) pointed to by `chars`
- pub len: usize
+ pub len: usize,
+ /// Whether the data pointed to by `chars` should be freed or not.
+ pub chars_is_owned: bool,
}
impl Into<Str> for &'static str {
fn into(self) -> Str {
- Str { chars: self.as_ptr(), len: self.len() }
+ Str { chars: self.as_ptr(), len: self.len(), chars_is_owned: false }
}
}
-impl Into<&'static str> for Str {
- fn into(self) -> &'static str {
+impl Str {
+ pub(crate) fn into_str(&self) -> &'static str {
if self.len == 0 { return ""; }
std::str::from_utf8(unsafe { std::slice::from_raw_parts(self.chars, self.len) }).unwrap()
}
+ pub(crate) fn into_string(mut self) -> String {
+ let bytes = if self.len == 0 {
+ Vec::new()
+ } else if self.chars_is_owned {
+ let ret = unsafe {
+ Box::from_raw(std::slice::from_raw_parts_mut(unsafe { self.chars as *mut u8 }, self.len))
+ }.into();
+ self.chars_is_owned = false;
+ ret
+ } else {
+ let mut ret = Vec::with_capacity(self.len);
+ ret.extend_from_slice(unsafe { std::slice::from_raw_parts(self.chars, self.len) });
+ ret
+ };
+ String::from_utf8(bytes).unwrap()
+ }
+}
+impl Into<Str> for String {
+ fn into(self) -> Str {
+ let s = Box::leak(self.into_boxed_str());
+ Str { chars: s.as_ptr(), len: s.len(), chars_is_owned: true }
+ }
+}
+
+impl Drop for Str {
+ fn drop(&mut self) {
+ if self.chars_is_owned && self.len != 0 {
+ let _ = derived::CVec_u8Z { data: self.chars as *mut u8, datalen: self.len };
+ }
+ }
}
+#[no_mangle]
+/// Frees the data buffer, if chars_is_owned is set and len > 0.
+pub extern "C" fn Str_free(_res: Str) { }
// Note that the C++ headers memset(0) all the Templ types to avoid deallocation!
// Thus, they must gracefully handle being completely null in _free.
ret
}
}
+
+
+pub(crate) mod ObjOps {
+ #[inline]
+ #[must_use = "returns new dangling pointer"]
+ pub(crate) fn heap_alloc<T>(obj: T) -> *mut T {
+ let ptr = Box::into_raw(Box::new(obj));
+ nonnull_ptr_to_inner(ptr)
+ }
+ #[inline]
+ pub(crate) fn nonnull_ptr_to_inner<T>(ptr: *const T) -> *mut T {
+ if core::mem::size_of::<T>() == 0 {
+ // We map `None::<T>` as `T { inner: null, .. }` which works great for all
+ // non-Zero-Sized-Types `T`.
+ // For ZSTs, we need to differentiate between null implying `None` and null implying
+ // `Some` with no allocation.
+ // Thus, for ZSTs, we add one (usually) page here, which should always be aligned.
+ // Note that this relies on undefined behavior! A pointer to NULL may be valid, but a
+ // pointer to NULL + 4096 is almost certainly not. That said, Rust's existing use of
+ // `(*mut T)1` for the pointer we're adding to is also not defined, so we should be
+ // fine.
+ // Note that we add 4095 here as at least the Java client assumes that the low bit on
+ // any heap pointer is 0, which is generally provided by malloc, but which is not true
+ // for ZSTs "allocated" by `Box::new`.
+ debug_assert_eq!(ptr as usize, 1);
+ unsafe { (ptr as *mut T).cast::<u8>().add(4096 - 1).cast::<T>() }
+ } else {
+ // In order to get better test coverage, also increment non-ZST pointers with
+ // --cfg=test_mod_pointers, which is set in genbindings.sh for debug builds.
+ #[cfg(test_mod_pointers)]
+ unsafe { (ptr as *mut T).cast::<u8>().add(4096).cast::<T>() }
+ #[cfg(not(test_mod_pointers))]
+ unsafe { ptr as *mut T }
+ }
+ }
+ #[inline]
+ /// Invert nonnull_ptr_to_inner
+ pub(crate) fn untweak_ptr<T>(ptr: *mut T) -> *mut T {
+ if core::mem::size_of::<T>() == 0 {
+ unsafe { ptr.cast::<u8>().sub(4096 - 1).cast::<T>() }
+ } else {
+ #[cfg(test_mod_pointers)]
+ unsafe { ptr.cast::<u8>().sub(4096).cast::<T>() }
+ #[cfg(not(test_mod_pointers))]
+ ptr
+ }
+ }
+}
projects / ldk-c-bindings / blobdiff