X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-c-bindings%2Fsrc%2Fc_types%2Fmod.rs;h=71616375aabfc10a5784650328cf0803f45c24f1;hb=5266836421190e74f893a3f9de5182057c2bd9b8;hp=0bd976bac8f1e47ee75ad5995a0bf123ce8f01dd;hpb=3fef735ad0382272f55cce06aefa489bcfaa2eb9;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 0bd976b..7161637 100644 --- a/lightning-c-bindings/src/c_types/mod.rs +++ b/lightning-c-bindings/src/c_types/mod.rs @@ -5,13 +5,15 @@ pub mod derived; use bitcoin::Transaction as BitcoinTransaction; use bitcoin::hashes::Hash; -use bitcoin::secp256k1::key::PublicKey as SecpPublicKey; -use bitcoin::secp256k1::key::SecretKey as SecpSecretKey; -use bitcoin::secp256k1::Signature as SecpSignature; +use bitcoin::secp256k1::PublicKey as SecpPublicKey; +use bitcoin::secp256k1::SecretKey as SecpSecretKey; +use bitcoin::secp256k1::ecdsa::Signature as SecpSignature; use bitcoin::secp256k1::Error as SecpError; -use bitcoin::secp256k1::recovery::RecoveryId; -use bitcoin::secp256k1::recovery::RecoverableSignature as SecpRecoverableSignature; +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; use core::convert::TryInto; // Bindings need at least rustc 1.34 use core::ffi::c_void; @@ -23,6 +25,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, `!` @@ -46,6 +50,20 @@ 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") } } +/// 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.to_num()) } +} +impl Into for WitnessVersion { + fn into(self) -> address::WitnessVersion { + address::WitnessVersion::try_from(self.0).expect("WitnessVersion objects must be in the range 0..=16") + } +} + #[derive(Clone)] #[repr(C)] /// Represents a valid secp256k1 public key serialized in "compressed form" as a 33 byte array. @@ -67,6 +85,7 @@ impl PublicKey { } #[repr(C)] +#[derive(Clone)] /// Represents a valid secp256k1 secret key serialized as a 32 byte array. pub struct SecretKey { /// The bytes of the secret key @@ -131,6 +150,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 @@ -145,14 +186,18 @@ pub enum Secp256k1Error { InvalidSignature, /// Bad secret key InvalidSecretKey, + /// Bad shared secret. + InvalidSharedSecret, /// Bad recovery id InvalidRecoveryId, /// Invalid tweak for add_assign or mul_assign InvalidTweak, - /// tweak_add_check failed on an xonly public key - TweakCheckFailed, /// Didn't pass enough memory to context creation with preallocated memory NotEnoughMemory, + /// Bad set of public keys. + InvalidPublicKeySum, + /// The only valid parity values are 0 or 1. + InvalidParityValue, } impl Secp256k1Error { pub(crate) fn from_rust(err: SecpError) -> Self { @@ -162,13 +207,89 @@ impl Secp256k1Error { SecpError::InvalidPublicKey => Secp256k1Error::InvalidPublicKey, SecpError::InvalidSignature => Secp256k1Error::InvalidSignature, SecpError::InvalidSecretKey => Secp256k1Error::InvalidSecretKey, + SecpError::InvalidSharedSecret => Secp256k1Error::InvalidSharedSecret, SecpError::InvalidRecoveryId => Secp256k1Error::InvalidRecoveryId, SecpError::InvalidTweak => Secp256k1Error::InvalidTweak, - SecpError::TweakCheckFailed => Secp256k1Error::TweakCheckFailed, SecpError::NotEnoughMemory => Secp256k1Error::NotEnoughMemory, + SecpError::InvalidPublicKeySum => Secp256k1Error::InvalidPublicKeySum, + SecpError::InvalidParityValue(_) => Secp256k1Error::InvalidParityValue, + } + } + pub(crate) fn into_rust(self) -> SecpError { + let invalid_parity = secp256k1::Parity::from_i32(42).unwrap_err(); + match self { + Secp256k1Error::IncorrectSignature => SecpError::IncorrectSignature, + Secp256k1Error::InvalidMessage => SecpError::InvalidMessage, + Secp256k1Error::InvalidPublicKey => SecpError::InvalidPublicKey, + Secp256k1Error::InvalidSignature => SecpError::InvalidSignature, + Secp256k1Error::InvalidSecretKey => SecpError::InvalidSecretKey, + Secp256k1Error::InvalidSharedSecret => SecpError::InvalidSharedSecret, + Secp256k1Error::InvalidRecoveryId => SecpError::InvalidRecoveryId, + Secp256k1Error::InvalidTweak => SecpError::InvalidTweak, + Secp256k1Error::NotEnoughMemory => SecpError::NotEnoughMemory, + Secp256k1Error::InvalidPublicKeySum => SecpError::InvalidPublicKeySum, + Secp256k1Error::InvalidParityValue => SecpError::InvalidParityValue(invalid_parity), + } + } +} + +#[repr(C)] +#[derive(Copy, Clone)] +/// Represents an error returned from the bech32 library during validation of some bech32 data +pub enum Bech32Error { + /// String does not contain the separator character + MissingSeparator, + /// The checksum does not match the rest of the data + InvalidChecksum, + /// The data or human-readable part is too long or too short + InvalidLength, + /// Some part of the string contains an invalid character + InvalidChar(u32), + /// Some part of the data has an invalid value + InvalidData(u8), + /// The bit conversion failed due to a padding issue + InvalidPadding, + /// The whole string must be of one case + MixedCase, +} +impl Bech32Error { + pub(crate) fn from_rust(err: bech32::Error) -> Self { + match err { + bech32::Error::MissingSeparator => Self::MissingSeparator, + bech32::Error::InvalidChecksum => Self::InvalidChecksum, + bech32::Error::InvalidLength => Self::InvalidLength, + bech32::Error::InvalidChar(c) => Self::InvalidChar(c as u32), + bech32::Error::InvalidData(d) => Self::InvalidData(d), + bech32::Error::InvalidPadding => Self::InvalidPadding, + bech32::Error::MixedCase => Self::MixedCase, + } + } + pub(crate) fn into_rust(self) -> bech32::Error { + match self { + Self::MissingSeparator => bech32::Error::MissingSeparator, + Self::InvalidChecksum => bech32::Error::InvalidChecksum, + Self::InvalidLength => bech32::Error::InvalidLength, + Self::InvalidChar(c) => bech32::Error::InvalidChar(core::char::from_u32(c).expect("Invalid UTF-8 character in Bech32Error::InvalidChar")), + Self::InvalidData(d) => bech32::Error::InvalidData(d), + Self::InvalidPadding => bech32::Error::InvalidPadding, + Self::MixedCase => bech32::Error::MixedCase, } } } +#[no_mangle] +/// Creates a new Bech32Error which has the same data as `orig` +pub extern "C" fn Bech32Error_clone(orig: &Bech32Error) -> Bech32Error { orig.clone() } +#[no_mangle] +/// Releases any memory held by the given `Bech32Error` (which is currently none) +pub extern "C" fn Bech32Error_free(o: Bech32Error) { } + +#[repr(C)] +#[derive(Clone, Copy, PartialEq)] +/// Sub-errors which don't have specific information in them use this type. +pub struct Error { + /// Zero-Sized_types aren't consistent across Rust/C/C++, so we add some size here + pub _dummy: u8, +} #[repr(C)] #[allow(missing_docs)] // If there's no docs upstream, that's good enough for us @@ -194,52 +315,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(), "") } } @@ -497,7 +623,7 @@ impl Into for String { } impl Clone for Str { fn clone(&self) -> Self { - self.into_str().clone().into() + String::from(self.into_str()).into() } } @@ -550,10 +676,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) }; } } } @@ -654,7 +780,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) }; } } }