X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-c-bindings%2Fsrc%2Fc_types%2Fmod.rs;h=f23f002d05c7ccfe8607ffd5b30eae0c79d0017b;hb=bcf07b1fad32d14e92c9c30976aa66b72a3860b0;hp=471b067ac94fab9d19e1e6f034fdf49d1eea8cc2;hpb=f8078e127bd05d8056f13245656bcc0af8f3e08d;p=ldk-c-bindings diff --git a/lightning-c-bindings/src/c_types/mod.rs b/lightning-c-bindings/src/c_types/mod.rs index 471b067..f23f002 100644 --- a/lightning-c-bindings/src/c_types/mod.rs +++ b/lightning-c-bindings/src/c_types/mod.rs @@ -4,6 +4,7 @@ pub mod derived; use bitcoin::Transaction as BitcoinTransaction; +use bitcoin::Witness as BitcoinWitness; use bitcoin::hashes::Hash; use bitcoin::secp256k1::PublicKey as SecpPublicKey; use bitcoin::secp256k1::SecretKey as SecpSecretKey; @@ -11,6 +12,7 @@ use bitcoin::secp256k1::ecdsa::Signature as SecpSignature; use bitcoin::secp256k1::Error as SecpError; use bitcoin::secp256k1::ecdsa::RecoveryId; use bitcoin::secp256k1::ecdsa::RecoverableSignature as SecpRecoverableSignature; +use bitcoin::secp256k1::Scalar as SecpScalar; use bitcoin::bech32; use bitcoin::util::address; @@ -24,6 +26,8 @@ pub(crate) use core2::io::{self, Cursor, Read}; #[cfg(feature = "no-std")] use alloc::{boxed::Box, vec::Vec, string::String}; +use core::convert::TryFrom; + #[repr(C)] /// A dummy struct of which an instance must never exist. /// This corresponds to the Rust type `Infallible`, or, in unstable rust, `!` @@ -38,25 +42,56 @@ impl From for NotConstructable { #[derive(PartialEq, Eq, Copy, Clone)] #[allow(non_camel_case_types)] #[repr(C)] -pub struct u5(u8); +pub struct U5(u8); -impl From for u5 { +impl From for U5 { fn from(o: bech32::u5) -> Self { Self(o.to_u8()) } } -impl Into for u5 { +impl Into for U5 { fn into(self) -> bech32::u5 { bech32::u5::try_from_u8(self.0).expect("u5 objects must be in the range 0..32") } } +/// Unsigned, 128-bit integer. +/// +/// Because LLVM implements an incorrect ABI for 128-bit integers, a wrapper type is defined here. +/// See https://github.com/rust-lang/rust/issues/54341 for more details. +#[derive(PartialEq, Eq, Copy, Clone)] +#[allow(non_camel_case_types)] +#[repr(C)] +pub struct U128 { + /// The 128-bit integer, as 16 little-endian bytes + pub le_bytes: [u8; 16], +} + +#[no_mangle] +/// Gets the 128-bit integer, as 16 little-endian bytes +pub extern "C" fn U128_le_bytes(val: U128) -> SixteenBytes { SixteenBytes { data: val.le_bytes } } +#[no_mangle] +/// Constructs a new U128 from 16 little-endian bytes +pub extern "C" fn U128_new(le_bytes: SixteenBytes) -> U128 { U128 { le_bytes: le_bytes.data } } + +impl From for U128 { + fn from(o: u128) -> Self { Self { le_bytes: o.to_le_bytes() } } +} +impl From<&mut u128> for U128 { + fn from(o: &mut u128) -> U128 { Self::from(*o) } +} +impl Into for U128 { + fn into(self) -> u128 { u128::from_le_bytes(self.le_bytes) } +} + /// Integer in the range `0..=16` #[derive(PartialEq, Eq, Copy, Clone)] #[repr(C)] pub struct WitnessVersion(u8); impl From for WitnessVersion { - fn from(o: address::WitnessVersion) -> Self { Self(o.into_num()) } + fn from(o: address::WitnessVersion) -> Self { Self(o.to_num()) } } impl Into for WitnessVersion { - fn into(self) -> address::WitnessVersion { address::WitnessVersion::from_num(self.0).expect("WitnessVersion objects must be in the range 0..=16") } + fn into(self) -> address::WitnessVersion { + address::WitnessVersion::try_from(self.0).expect("WitnessVersion objects must be in the range 0..=16") + } } #[derive(Clone)] @@ -145,6 +180,28 @@ impl RecoverableSignature { } } +#[repr(C)] +#[derive(Clone)] +/// Represents a scalar value between zero and the secp256k1 curve order, in big endian. +pub struct BigEndianScalar { + /// The bytes of the scalar value. + pub big_endian_bytes: [u8; 32], +} +impl BigEndianScalar { + pub(crate) fn from_rust(scalar: &SecpScalar) -> Self { + Self { big_endian_bytes: scalar.to_be_bytes() } + } + pub(crate) fn into_rust(&self) -> SecpScalar { + SecpScalar::from_be_bytes(self.big_endian_bytes).expect("Scalar greater than the curve order") + } +} + +#[no_mangle] +/// Convenience function for constructing a new BigEndianScalar +pub extern "C" fn BigEndianScalar_new(big_endian_bytes: ThirtyTwoBytes) -> BigEndianScalar { + BigEndianScalar { big_endian_bytes: big_endian_bytes.data } +} + #[repr(C)] #[derive(Copy, Clone)] /// Represents an error returned from libsecp256k1 during validation of some secp256k1 data @@ -288,52 +345,57 @@ pub enum IOError { Other, UnexpectedEof, } -#[cfg(feature = "std")] impl IOError { - pub(crate) fn from_rust(err: std::io::Error) -> Self { - match err.kind() { - std::io::ErrorKind::NotFound => IOError::NotFound, - std::io::ErrorKind::PermissionDenied => IOError::PermissionDenied, - std::io::ErrorKind::ConnectionRefused => IOError::ConnectionRefused, - std::io::ErrorKind::ConnectionReset => IOError::ConnectionReset, - std::io::ErrorKind::ConnectionAborted => IOError::ConnectionAborted, - std::io::ErrorKind::NotConnected => IOError::NotConnected, - std::io::ErrorKind::AddrInUse => IOError::AddrInUse, - std::io::ErrorKind::AddrNotAvailable => IOError::AddrNotAvailable, - std::io::ErrorKind::BrokenPipe => IOError::BrokenPipe, - std::io::ErrorKind::AlreadyExists => IOError::AlreadyExists, - std::io::ErrorKind::WouldBlock => IOError::WouldBlock, - std::io::ErrorKind::InvalidInput => IOError::InvalidInput, - std::io::ErrorKind::InvalidData => IOError::InvalidData, - std::io::ErrorKind::TimedOut => IOError::TimedOut, - std::io::ErrorKind::WriteZero => IOError::WriteZero, - std::io::ErrorKind::Interrupted => IOError::Interrupted, - std::io::ErrorKind::Other => IOError::Other, - std::io::ErrorKind::UnexpectedEof => IOError::UnexpectedEof, + pub(crate) fn from_rust_kind(err: io::ErrorKind) -> Self { + match err { + io::ErrorKind::NotFound => IOError::NotFound, + io::ErrorKind::PermissionDenied => IOError::PermissionDenied, + io::ErrorKind::ConnectionRefused => IOError::ConnectionRefused, + io::ErrorKind::ConnectionReset => IOError::ConnectionReset, + io::ErrorKind::ConnectionAborted => IOError::ConnectionAborted, + io::ErrorKind::NotConnected => IOError::NotConnected, + io::ErrorKind::AddrInUse => IOError::AddrInUse, + io::ErrorKind::AddrNotAvailable => IOError::AddrNotAvailable, + io::ErrorKind::BrokenPipe => IOError::BrokenPipe, + io::ErrorKind::AlreadyExists => IOError::AlreadyExists, + io::ErrorKind::WouldBlock => IOError::WouldBlock, + io::ErrorKind::InvalidInput => IOError::InvalidInput, + io::ErrorKind::InvalidData => IOError::InvalidData, + io::ErrorKind::TimedOut => IOError::TimedOut, + io::ErrorKind::WriteZero => IOError::WriteZero, + io::ErrorKind::Interrupted => IOError::Interrupted, + io::ErrorKind::Other => IOError::Other, + io::ErrorKind::UnexpectedEof => IOError::UnexpectedEof, _ => 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, - }, "") + pub(crate) fn from_rust(err: io::Error) -> Self { + Self::from_rust_kind(err.kind()) + } + pub(crate) fn to_rust_kind(&self) -> io::ErrorKind { + match self { + IOError::NotFound => io::ErrorKind::NotFound, + IOError::PermissionDenied => io::ErrorKind::PermissionDenied, + IOError::ConnectionRefused => io::ErrorKind::ConnectionRefused, + IOError::ConnectionReset => io::ErrorKind::ConnectionReset, + IOError::ConnectionAborted => io::ErrorKind::ConnectionAborted, + IOError::NotConnected => io::ErrorKind::NotConnected, + IOError::AddrInUse => io::ErrorKind::AddrInUse, + IOError::AddrNotAvailable => io::ErrorKind::AddrNotAvailable, + IOError::BrokenPipe => io::ErrorKind::BrokenPipe, + IOError::AlreadyExists => io::ErrorKind::AlreadyExists, + IOError::WouldBlock => io::ErrorKind::WouldBlock, + IOError::InvalidInput => io::ErrorKind::InvalidInput, + IOError::InvalidData => io::ErrorKind::InvalidData, + IOError::TimedOut => io::ErrorKind::TimedOut, + IOError::WriteZero => io::ErrorKind::WriteZero, + IOError::Interrupted => io::ErrorKind::Interrupted, + IOError::Other => io::ErrorKind::Other, + IOError::UnexpectedEof => io::ErrorKind::UnexpectedEof, + } + } + pub(crate) fn to_rust(&self) -> io::Error { + io::Error::new(self.to_rust_kind(), "") } } @@ -399,6 +461,57 @@ impl Clone for Transaction { /// Frees the data buffer, if data_is_owned is set and datalen > 0. pub extern "C" fn Transaction_free(_res: Transaction) { } +#[repr(C)] +/// A serialized witness. +pub struct Witness { + /// The serialized transaction data. + /// + /// This is non-const for your convenience, an object passed to Rust is never written to. + pub data: *mut u8, + /// The length of the serialized transaction + pub datalen: usize, + /// Whether the data pointed to by `data` should be freed or not. + pub data_is_owned: bool, +} +impl Witness { + fn from_vec(vec: Vec) -> Self { + let datalen = vec.len(); + let data = Box::into_raw(vec.into_boxed_slice()); + Self { + data: unsafe { (*data).as_mut_ptr() }, + datalen, + data_is_owned: true, + } + } + pub(crate) fn into_bitcoin(&self) -> BitcoinWitness { + ::bitcoin::consensus::encode::deserialize(unsafe { core::slice::from_raw_parts(self.data, self.datalen) }).unwrap() + } + pub(crate) fn from_bitcoin(btc: &BitcoinWitness) -> Self { + let vec = ::bitcoin::consensus::encode::serialize(btc); + Self::from_vec(vec) + } +} + +impl Drop for Witness { + fn drop(&mut self) { + if self.data_is_owned && self.datalen != 0 { + let _ = derived::CVec_u8Z { data: self.data as *mut u8, datalen: self.datalen }; + } + } +} +impl Clone for Witness { + fn clone(&self) -> Self { + let sl = unsafe { core::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 pointed to by data +pub extern "C" fn Witness_free(_res: Witness) { } + pub(crate) fn bitcoin_to_C_outpoint(outpoint: ::bitcoin::blockdata::transaction::OutPoint) -> crate::lightning::chain::transaction::OutPoint { crate::lightning::chain::transaction::OutPoint_new(ThirtyTwoBytes { data: outpoint.txid.into_inner() }, outpoint.vout.try_into().unwrap()) } @@ -644,10 +757,10 @@ impl Drop for CResultTempl { fn drop(&mut self) { if self.result_ok { if unsafe { !self.contents.result.is_null() } { - unsafe { Box::from_raw(self.contents.result) }; + let _ = unsafe { Box::from_raw(self.contents.result) }; } } else if unsafe { !self.contents.err.is_null() } { - unsafe { Box::from_raw(self.contents.err) }; + let _ = unsafe { Box::from_raw(self.contents.err) }; } } } @@ -748,7 +861,7 @@ impl SmartPtr { impl Drop for SmartPtr { fn drop(&mut self) { if self.ptr != core::ptr::null_mut() { - unsafe { Box::from_raw(self.ptr); } + let _ = unsafe { Box::from_raw(self.ptr) }; } } }