]> git.bitcoin.ninja Git - ldk-c-bindings/blobdiff - lightning-c-bindings/src/c_types/mod.rs
Add missing `rustc` `metadata` override for `lightning_types`
[ldk-c-bindings] / lightning-c-bindings / src / c_types / mod.rs
index f23f002d05c7ccfe8607ffd5b30eae0c79d0017b..5fd9857cd1b363196e512ef8a38ab4e78c6afe67 100644 (file)
@@ -5,24 +5,27 @@ pub mod derived;
 
 use bitcoin::Transaction as BitcoinTransaction;
 use bitcoin::Witness as BitcoinWitness;
+use bitcoin::address;
+use bitcoin::WitnessProgram as BitcoinWitnessProgram;
+use bitcoin::WitnessVersion as BitcoinWitnessVersion;
+use bitcoin::key::TweakedPublicKey as BitcoinTweakedPublicKey;
+use bitcoin::key::XOnlyPublicKey;
 use bitcoin::hashes::Hash;
 use bitcoin::secp256k1::PublicKey as SecpPublicKey;
 use bitcoin::secp256k1::SecretKey as SecpSecretKey;
-use bitcoin::secp256k1::ecdsa::Signature as SecpSignature;
+use bitcoin::secp256k1::ecdsa::Signature as ECDSASecpSignature;
+use bitcoin::secp256k1::schnorr::Signature as SchnorrSecpSignature;
 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;
+use bech32;
 
 use core::convert::TryInto; // Bindings need at least rustc 1.34
+use alloc::borrow::ToOwned;
 use core::ffi::c_void;
 
-#[cfg(feature = "std")]
-pub(crate) use std::io::{self, Cursor, Read};
-#[cfg(feature = "no-std")]
-pub(crate) use core2::io::{self, Cursor, Read};
+pub(crate) use bitcoin::io::{self, Cursor, Read};
 #[cfg(feature = "no-std")]
 use alloc::{boxed::Box, vec::Vec, string::String};
 
@@ -85,14 +88,66 @@ impl Into<u128> for U128 {
 #[repr(C)]
 pub struct WitnessVersion(u8);
 
-impl From<address::WitnessVersion> for WitnessVersion {
-       fn from(o: address::WitnessVersion) -> Self { Self(o.to_num()) }
+impl From<BitcoinWitnessVersion> for WitnessVersion {
+       fn from(o: BitcoinWitnessVersion) -> Self { Self(o.to_num()) }
+}
+impl Into<BitcoinWitnessVersion> for WitnessVersion {
+       fn into(self) -> BitcoinWitnessVersion {
+               BitcoinWitnessVersion::try_from(self.0).expect("WitnessVersion objects must be in the range 0..=16")
+       }
+}
+
+/// A segregated witness version byte and script bytes
+#[repr(C)]
+#[derive(Clone)]
+pub struct WitnessProgram {
+       version: WitnessVersion,
+       program: derived::CVec_u8Z,
+}
+impl WitnessProgram {
+       pub(crate) fn from_bitcoin(o: BitcoinWitnessProgram) -> Self {
+               Self {
+                       version: o.version().into(),
+                       program: o.program().as_bytes().to_vec().into(),
+               }
+       }
+       pub(crate) fn into_bitcoin(mut self) -> BitcoinWitnessProgram {
+               BitcoinWitnessProgram::new(
+                       self.version.into(),
+                       self.program.as_slice(),
+               ).expect("Program length was previously checked")
+       }
 }
-impl Into<address::WitnessVersion> for WitnessVersion {
-       fn into(self) -> address::WitnessVersion {
-               address::WitnessVersion::try_from(self.0).expect("WitnessVersion objects must be in the range 0..=16")
+
+#[no_mangle]
+/// Constructs a new WitnessProgram given a version and program bytes.
+///
+/// The program MUST be at least 2 bytes and no longer than 40 bytes long.
+/// Further, if the version is 0, the program MUST be either exactly 20 or exactly 32 bytes long.
+pub extern "C" fn WitnessProgram_new(version: WitnessVersion, program: derived::CVec_u8Z) -> WitnessProgram {
+       assert!(program.datalen >= 2, "WitnessProgram program lengths must be at least 2 bytes long");
+       assert!(program.datalen <= 40, "WitnessProgram program lengths must be no longer than 40 bytes");
+       if version.0 == 0 {
+               assert!(program.datalen == 20 || program.datalen == 32, "WitnessProgram program length must be 20 or 32 for version-0 programs");
        }
+       WitnessProgram { version, program }
 }
+#[no_mangle]
+/// Gets the `WitnessVersion` of the given `WitnessProgram`
+pub extern "C" fn WitnessProgram_get_version(prog: &WitnessProgram) -> WitnessVersion {
+       prog.version
+}
+#[no_mangle]
+/// Gets the witness program bytes of the given `WitnessProgram`
+pub extern "C" fn WitnessProgram_get_program(prog: &WitnessProgram) -> u8slice {
+       u8slice::from_vec(&prog.program)
+}
+#[no_mangle]
+/// Creates a new WitnessProgram which has the same data as `orig`
+pub extern "C" fn WitnessProgram_clone(orig: &WitnessProgram) -> WitnessProgram { orig.clone() }
+#[no_mangle]
+/// Releases any memory held by the given `WitnessProgram` (which is currently none)
+pub extern "C" fn WitnessProgram_free(o: WitnessProgram) { }
 
 #[derive(Clone)]
 #[repr(C)]
@@ -114,6 +169,25 @@ impl PublicKey {
        pub(crate) fn null() -> Self { Self { compressed_form: [0; 33] } }
 }
 
+#[derive(Clone)]
+#[repr(C)]
+/// Represents a tweaked X-only public key as required for BIP 340 (Taproot).
+pub struct TweakedPublicKey {
+       /// The bytes of the public key X coordinate
+       pub x_coordinate: [u8; 32],
+}
+impl TweakedPublicKey {
+       pub(crate) fn from_rust(pk: &BitcoinTweakedPublicKey) -> Self {
+               Self {
+                       x_coordinate: pk.serialize(),
+               }
+       }
+       pub(crate) fn into_rust(&self) -> BitcoinTweakedPublicKey {
+               let xonly_key = XOnlyPublicKey::from_slice(&self.x_coordinate).unwrap();
+               BitcoinTweakedPublicKey::dangerous_assume_tweaked(xonly_key)
+       }
+}
+
 #[repr(C)]
 #[derive(Clone)]
 /// Represents a valid secp256k1 secret key serialized as a 32 byte array.
@@ -135,23 +209,38 @@ impl SecretKey {
 
 #[repr(C)]
 #[derive(Clone)]
-/// Represents a secp256k1 signature serialized as two 32-byte numbers
-pub struct Signature {
+/// Represents a secp256k1 ECDSA signature serialized as two 32-byte numbers
+pub struct ECDSASignature {
        /// The bytes of the signature in "compact" form
        pub compact_form: [u8; 64],
 }
-impl Signature {
-       pub(crate) fn from_rust(pk: &SecpSignature) -> Self {
+impl ECDSASignature {
+       pub(crate) fn from_rust(pk: &ECDSASecpSignature) -> Self {
                Self {
                        compact_form: pk.serialize_compact(),
                }
        }
-       pub(crate) fn into_rust(&self) -> SecpSignature {
-               SecpSignature::from_compact(&self.compact_form).unwrap()
+       pub(crate) fn into_rust(&self) -> ECDSASecpSignature {
+               ECDSASecpSignature::from_compact(&self.compact_form).unwrap()
+       }
+}
+
+#[repr(C)]
+#[derive(Clone)]
+/// Represents a secp256k1 Schnorr signature serialized as two 32-byte numbers
+pub struct SchnorrSignature {
+       /// The bytes of the signature as two 32-byte numbers
+       pub compact_form: [u8; 64],
+}
+impl SchnorrSignature {
+       pub(crate) fn from_rust(pk: &SchnorrSecpSignature) -> Self {
+               Self {
+                       compact_form: pk.as_ref().clone(),
+               }
+       }
+       pub(crate) fn into_rust(&self) -> SchnorrSecpSignature {
+               SchnorrSecpSignature::from_slice(&self.compact_form).unwrap()
        }
-       // The following are used for Option<Signature> which we support, but don't use anymore
-       #[allow(unused)] pub(crate) fn is_null(&self) -> bool { self.compact_form[..] == [0; 64][..] }
-       #[allow(unused)] pub(crate) fn null() -> Self { Self { compact_form: [0; 64] } }
 }
 
 #[repr(C)]
@@ -201,6 +290,9 @@ impl BigEndianScalar {
 pub extern "C" fn BigEndianScalar_new(big_endian_bytes: ThirtyTwoBytes) -> BigEndianScalar {
        BigEndianScalar { big_endian_bytes: big_endian_bytes.data }
 }
+#[no_mangle]
+/// Creates a new BigEndianScalar which has the same data as `orig`
+pub extern "C" fn BigEndianScalar_clone(orig: &BigEndianScalar) -> BigEndianScalar { orig.clone() }
 
 #[repr(C)]
 #[derive(Copy, Clone)]
@@ -228,6 +320,8 @@ pub enum Secp256k1Error {
        InvalidPublicKeySum,
        /// The only valid parity values are 0 or 1.
        InvalidParityValue,
+       /// Invalid Elligator Swift Value
+       InvalidEllSwift,
 }
 impl Secp256k1Error {
        pub(crate) fn from_rust(err: SecpError) -> Self {
@@ -242,6 +336,7 @@ impl Secp256k1Error {
                        SecpError::InvalidTweak => Secp256k1Error::InvalidTweak,
                        SecpError::NotEnoughMemory => Secp256k1Error::NotEnoughMemory,
                        SecpError::InvalidPublicKeySum => Secp256k1Error::InvalidPublicKeySum,
+                       SecpError::InvalidEllSwift => Secp256k1Error::InvalidEllSwift,
                        SecpError::InvalidParityValue(_) => Secp256k1Error::InvalidParityValue,
                }
        }
@@ -258,6 +353,7 @@ impl Secp256k1Error {
                        Secp256k1Error::InvalidTweak => SecpError::InvalidTweak,
                        Secp256k1Error::NotEnoughMemory => SecpError::NotEnoughMemory,
                        Secp256k1Error::InvalidPublicKeySum => SecpError::InvalidPublicKeySum,
+                       Secp256k1Error::InvalidEllSwift => SecpError::InvalidEllSwift,
                        Secp256k1Error::InvalidParityValue => SecpError::InvalidParityValue(invalid_parity),
                }
        }
@@ -366,12 +462,15 @@ impl IOError {
                        io::ErrorKind::Interrupted => IOError::Interrupted,
                        io::ErrorKind::Other => IOError::Other,
                        io::ErrorKind::UnexpectedEof => IOError::UnexpectedEof,
-                       _ => IOError::Other,
                }
        }
-       pub(crate) fn from_rust(err: io::Error) -> Self {
+       pub(crate) fn from_bitcoin(err: io::Error) -> Self {
                Self::from_rust_kind(err.kind())
        }
+       #[cfg(feature = "std")]
+       pub(crate) fn from_rust(err: std::io::Error) -> Self {
+               Self::from_bitcoin(err.into())
+       }
        pub(crate) fn to_rust_kind(&self) -> io::ErrorKind {
                match self {
                        IOError::NotFound => io::ErrorKind::NotFound,
@@ -508,12 +607,16 @@ impl Clone for Witness {
        }
 }
 
+#[no_mangle]
+/// Creates a new Witness which has the same data as `orig` but with a new buffer.
+pub extern "C" fn Witness_clone(orig: &Witness) -> Witness { orig.clone() }
+
 #[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())
+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.as_ref() }, outpoint.vout.try_into().unwrap())
 }
 pub(crate) fn C_to_bitcoin_outpoint(outpoint: crate::lightning::chain::transaction::OutPoint) -> ::bitcoin::blockdata::transaction::OutPoint {
        unsafe {
@@ -523,6 +626,71 @@ pub(crate) fn C_to_bitcoin_outpoint(outpoint: crate::lightning::chain::transacti
        }
 }
 
+#[repr(C)]
+#[derive(Clone)]
+/// An input to a transaction.
+///
+/// This contains the witness, the scriptSig and the previous outpoint and represents a single
+/// input to a transaction
+pub struct TxIn {
+       /// The witness which includes any signatures required to spend a segwit output.
+       pub witness: Witness,
+       /// The script_sig which includes signatures requires to spend a pre-segwit output (or a
+       /// P2SH-wrapped segwit output).
+       pub script_sig: derived::CVec_u8Z,
+       /// The sequence number of the transaction input
+       pub sequence: u32,
+       /// The txid of the transaction being spent.
+       pub previous_txid: ThirtyTwoBytes,
+       /// The output index of the transaction being spent.
+       pub previous_vout: u32,
+}
+
+impl TxIn {
+       pub(crate) fn from_rust(txin: &::bitcoin::blockdata::transaction::TxIn) -> Self {
+               TxIn {
+                       witness: Witness::from_bitcoin(&txin.witness),
+                       script_sig: derived::CVec_u8Z::from(txin.script_sig.clone().into_bytes()),
+                       sequence: txin.sequence.0,
+                       previous_txid: ThirtyTwoBytes { data: *txin.previous_output.txid.as_ref() },
+                       previous_vout: txin.previous_output.vout,
+               }
+       }
+}
+#[no_mangle]
+/// Convenience function for constructing a new TxIn
+pub extern "C" fn TxIn_new(witness: Witness, script_sig: derived::CVec_u8Z, sequence: u32, previous_txid: ThirtyTwoBytes, previous_vout: u32) -> TxIn {
+       TxIn { witness, script_sig, sequence, previous_txid, previous_vout }
+}
+#[no_mangle]
+/// Gets the `witness` in the given `TxIn`.
+pub extern "C" fn TxIn_get_witness(txin: &TxIn) -> Witness {
+       txin.witness.clone()
+}
+#[no_mangle]
+/// Gets the `script_sig` in the given `TxIn`.
+pub extern "C" fn TxIn_get_script_sig(txin: &TxIn) -> u8slice {
+       u8slice::from_vec(&txin.script_sig)
+}
+#[no_mangle]
+/// Gets the `sequence` in the given `TxIn`.
+pub extern "C" fn TxIn_get_sequence(txin: &TxIn) -> u32 {
+       txin.sequence
+}
+#[no_mangle]
+/// Gets the previous outpoint txid in the given `TxIn`.
+pub extern "C" fn TxIn_get_previous_txid(txin: &TxIn) -> ThirtyTwoBytes {
+       txin.previous_txid
+}
+#[no_mangle]
+/// Gets the previout outpoint index in the given `TxIn`.
+pub extern "C" fn TxIn_get_previous_vout(txin: &TxIn) -> u32 {
+       txin.previous_vout
+}
+#[no_mangle]
+/// Frees the witness and script_sig in a TxIn
+pub extern "C" fn TxIn_free(_res: TxIn) { }
+
 #[repr(C)]
 #[derive(Clone)]
 /// A transaction output including a scriptPubKey and value.
@@ -538,13 +706,13 @@ impl TxOut {
        pub(crate) fn into_rust(mut self) -> ::bitcoin::blockdata::transaction::TxOut {
                ::bitcoin::blockdata::transaction::TxOut {
                        script_pubkey: self.script_pubkey.into_rust().into(),
-                       value: self.value,
+                       value: bitcoin::Amount::from_sat(self.value),
                }
        }
-       pub(crate) fn from_rust(txout: ::bitcoin::blockdata::transaction::TxOut) -> Self {
+       pub(crate) fn from_rust(txout: &::bitcoin::blockdata::transaction::TxOut) -> Self {
                Self {
-                       script_pubkey: derived::CVec_u8Z::from(txout.script_pubkey.into_bytes()),
-                       value: txout.value
+                       script_pubkey: derived::CVec_u8Z::from(txout.script_pubkey.clone().into_bytes()),
+                       value: txout.value.to_sat()
                }
        }
 }
@@ -555,6 +723,16 @@ pub extern "C" fn TxOut_new(script_pubkey: derived::CVec_u8Z, value: u64) -> TxO
        TxOut { script_pubkey, value }
 }
 #[no_mangle]
+/// Gets the `script_pubkey` in the given `TxOut`.
+pub extern "C" fn TxOut_get_script_pubkey(txout: &TxOut) -> u8slice {
+       u8slice::from_vec(&txout.script_pubkey)
+}
+#[no_mangle]
+/// Gets the value in the given `TxOut`.
+pub extern "C" fn TxOut_get_value(txout: &TxOut) -> u64 {
+       txout.value
+}
+#[no_mangle]
 /// Frees the data pointed to by script_pubkey.
 pub extern "C" fn TxOut_free(_res: TxOut) { }
 #[no_mangle]
@@ -591,7 +769,7 @@ impl u8slice {
 }
 pub(crate) fn reader_to_vec<R: Read>(r: &mut R) -> derived::CVec_u8Z {
        let mut res = Vec::new();
-       r.read_to_end(&mut res).unwrap();
+       r.read_to_limit(&mut res, u64::MAX).unwrap();
        derived::CVec_u8Z::from(res)
 }
 
@@ -603,12 +781,8 @@ pub struct ThirtyTwoBytes {
        /// The thirty-two bytes
        pub data: [u8; 32],
 }
-impl ThirtyTwoBytes {
-       pub(crate) fn null() -> Self {
-               Self { data: [0; 32] }
-       }
-}
 
+#[derive(Clone)]
 #[repr(C)]
 /// A 3-byte byte array.
 pub struct ThreeBytes { /** The three bytes */ pub data: [u8; 3], }
@@ -629,6 +803,11 @@ pub struct SixteenBytes { /** The sixteen bytes */ pub data: [u8; 16], }
 /// A 20-byte byte array.
 pub struct TwentyBytes { /** The twenty bytes */ pub data: [u8; 20], }
 
+#[derive(Clone)]
+#[repr(C)]
+/// 32 u16s
+pub struct ThirtyTwoU16s { /** The thirty-two 16-bit integers */ pub data: [u16; 32], }
+
 pub(crate) struct VecWriter(pub Vec<u8>);
 impl lightning::util::ser::Writer for VecWriter {
        fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
@@ -662,14 +841,14 @@ pub struct Str {
        /// Whether the data pointed to by `chars` should be freed or not.
        pub chars_is_owned: bool,
 }
-impl Into<Str> for &'static str {
+impl Into<Str> for &str {
        fn into(self) -> Str {
-               Str { chars: self.as_ptr(), len: self.len(), chars_is_owned: false }
+               self.to_owned().into()
        }
 }
-impl Into<Str> for &mut &'static str {
+impl Into<Str> for &mut &str {
        fn into(self) -> Str {
-               let us: &'static str = *self;
+               let us: &str = *self;
                us.into()
        }
 }
@@ -695,6 +874,16 @@ impl Str {
                };
                String::from_utf8(bytes).unwrap()
        }
+       #[cfg(feature = "std")]
+       pub(crate) fn into_pathbuf(mut self) -> std::path::PathBuf {
+               std::path::PathBuf::from(self.into_string())
+       }
+       pub(crate) fn from_rust(s: &str) -> Self {
+               s.into()
+       }
+       pub(crate) fn is_empty(&self) -> bool {
+               self.len == 0
+       }
 }
 impl Into<Str> for String {
        fn into(self) -> Str {
@@ -702,6 +891,12 @@ impl Into<Str> for String {
                Str { chars: s.as_ptr(), len: s.len(), chars_is_owned: true }
        }
 }
+#[cfg(feature = "std")]
+impl Into<Str> for std::path::PathBuf {
+       fn into(self) -> Str {
+               self.into_os_string().into_string().expect("We expect paths to be UTF-8 valid").into()
+       }
+}
 impl Clone for Str {
        fn clone(&self) -> Self {
                String::from(self.into_str()).into()