Update hardcoded and manually-defined types for LDK 0.0.117
[ldk-c-bindings] / lightning-c-bindings / src / c_types / mod.rs
index cf708d03df49082d47d4ad6e6428679d413b25ff..eb9be439a1acf06b9a7ab8fe6b0676b37ccc195d 100644 (file)
@@ -8,7 +8,8 @@ use bitcoin::Witness as BitcoinWitness;
 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;
@@ -17,6 +18,7 @@ use bitcoin::bech32;
 use bitcoin::util::address;
 
 use core::convert::TryInto; // Bindings need at least rustc 1.34
+use alloc::borrow::ToOwned;
 use core::ffi::c_void;
 
 #[cfg(feature = "std")]
@@ -135,23 +137,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)]
@@ -508,11 +525,15 @@ 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 {
+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 C_to_bitcoin_outpoint(outpoint: crate::lightning::chain::transaction::OutPoint) -> ::bitcoin::blockdata::transaction::OutPoint {
@@ -523,6 +544,49 @@ 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.into_inner() },
+                       previous_vout: txin.previous_output.vout,
+               }
+       }
+}
+
+#[no_mangle]
+/// Frees the witness and script_sig in a TxIn
+pub extern "C" fn TxIn_free(_res: TxIn) { }
+
+#[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 }
+}
+
+
 #[repr(C)]
 #[derive(Clone)]
 /// A transaction output including a scriptPubKey and value.
@@ -541,9 +605,9 @@ impl TxOut {
                        value: 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()),
+                       script_pubkey: derived::CVec_u8Z::from(txout.script_pubkey.clone().into_bytes()),
                        value: txout.value
                }
        }
@@ -603,11 +667,6 @@ pub struct ThirtyTwoBytes {
        /// The thirty-two bytes
        pub data: [u8; 32],
 }
-impl ThirtyTwoBytes {
-       pub(crate) fn null() -> Self {
-               Self { data: [0; 32] }
-       }
-}
 
 #[repr(C)]
 /// A 3-byte byte array.
@@ -631,8 +690,8 @@ pub struct TwentyBytes { /** The twenty bytes */ pub data: [u8; 20], }
 
 #[derive(Clone)]
 #[repr(C)]
-/// 8 u16s
-pub struct EightU16s { /** The eight 16-bit integers */ pub data: [u16; 8], }
+/// 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 {
@@ -667,14 +726,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()
        }
 }
@@ -700,6 +759,10 @@ 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())
+       }
 }
 impl Into<Str> for String {
        fn into(self) -> Str {
@@ -707,6 +770,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()