X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-c-bindings%2Fsrc%2Fc_types%2Fmod.rs;h=3fe5eb62eece32b501e415fa22ae8bca1846d088;hb=e8ac9011500460f5d13174c6bad634aa69de154e;hp=1cb1eccebd0f0519f5f1a156d29fd90bf7e8b802;hpb=f88af9aa921bde9f84d86f11df40b6623ba45fb5;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 1cb1ecc..3fe5eb6 100644 --- a/lightning-c-bindings/src/c_types/mod.rs +++ b/lightning-c-bindings/src/c_types/mod.rs @@ -5,18 +5,21 @@ pub mod derived; use bitcoin::Transaction as BitcoinTransaction; use bitcoin::Witness as BitcoinWitness; +use bitcoin::address; +use bitcoin::address::WitnessProgram as BitcoinWitnessProgram; 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 core::convert::TryInto; // Bindings need at least rustc 1.34 +use alloc::borrow::ToOwned; use core::ffi::c_void; #[cfg(feature = "std")] @@ -94,6 +97,58 @@ impl Into for WitnessVersion { } } +/// 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.into_rust(), + ).expect("Program length was previously checked") + } +} + +#[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)] /// Represents a valid secp256k1 public key serialized in "compressed form" as a 33 byte array. @@ -135,23 +190,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 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)] @@ -517,7 +587,7 @@ pub extern "C" fn Witness_clone(orig: &Witness) -> Witness { orig.clone() } 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()) + 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 { @@ -553,22 +623,44 @@ impl 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_txid: ThirtyTwoBytes { data: *txin.previous_output.txid.as_ref() }, 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 } } - +#[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)] @@ -602,6 +694,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] @@ -673,8 +775,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); impl lightning::util::ser::Writer for VecWriter { @@ -709,14 +811,14 @@ pub struct Str { /// Whether the data pointed to by `chars` should be freed or not. pub chars_is_owned: bool, } -impl Into for &'static str { +impl Into for &str { fn into(self) -> Str { - Str { chars: self.as_ptr(), len: self.len(), chars_is_owned: false } + self.to_owned().into() } } -impl Into for &mut &'static str { +impl Into for &mut &str { fn into(self) -> Str { - let us: &'static str = *self; + let us: &str = *self; us.into() } } @@ -742,6 +844,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 for String { fn into(self) -> Str { @@ -749,6 +855,12 @@ impl Into for String { Str { chars: s.as_ptr(), len: s.len(), chars_is_owned: true } } } +#[cfg(feature = "std")] +impl Into 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()