logos-blockchain-circuits/rust/logos-blockchain-circuits-poq-sys/src/native.rs

use crate::ffi::{poq_generate_witness, poq_generate_witness_from_files};
use lbc_common::string::path_as_null_terminated_string;
use lbc_types::{
    ffi,
    native::{Error, Witness},
};
use std::path::Path;

static RAW_CIRCUIT_DAT: &[u8] =
    include_bytes!(concat!(env!("LBC_POQ_LIB_DIR"), "/witness_generator.dat"));

pub struct PoqDat;
impl<'dat> lbc_types::CircuitDat<'dat> for PoqDat {
    const DAT: &'dat [u8] = RAW_CIRCUIT_DAT;
}

pub type PoqWitnessInput<'dat> = lbc_types::CircuitWitnessInput<'dat, PoqDat>;

pub fn generate_witness(input: &PoqWitnessInput) -> Result<Witness, Error> {
    let ffi_input_guard = input.as_ffi();
    let ffi_input = ffi_input_guard.as_ref();

    let mut ffi_output_bytes = ffi::Bytes::null();

    // SAFETY: ffi_input is a valid pointer and ffi_output_bytes is a locally initialized null Bytes.
    let status =
        unsafe { poq_generate_witness(std::ptr::from_ref(ffi_input), &raw mut ffi_output_bytes) };

    status.try_into().map(|()| Witness::from(ffi_output_bytes))
}

pub fn generate_witness_from_files(dat: &Path, inputs: &Path, output: &Path) -> Result<(), Error> {
    let c_dat = path_as_null_terminated_string(dat)?;
    let c_inputs = path_as_null_terminated_string(inputs)?;
    let c_output = path_as_null_terminated_string(output)?;

    // SAFETY: c_dat, c_inputs, and c_output are valid null-terminated C strings for the duration of the call.
    unsafe { poq_generate_witness_from_files(c_dat.as_ptr(), c_inputs.as_ptr(), c_output.as_ptr()) }
        .try_into()
}

#[cfg(test)]
mod tests {
    use super::{PoqWitnessInput, generate_witness, generate_witness_from_files};
    use std::path::PathBuf;
    use std::sync::LazyLock;

    static LIB_DIR: LazyLock<PathBuf> = LazyLock::new(|| {
        const ENV_VAR: &str = "LBC_POQ_LIB_DIR";
        PathBuf::from(
            std::env::var(ENV_VAR).unwrap_or_else(
                |_| panic!("Environment variable '{ENV_VAR}' must be available, as provided by the build script."),
            )
        )
    });
    static INPUTS: LazyLock<PathBuf> =
        LazyLock::new(|| PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("sample.input.json"));

    #[test]
    fn test_generate_witness() {
        let dat = LIB_DIR.join("witness_generator");
        let witness_output_path = std::env::temp_dir().join("poq_test_witness.wtns");

        generate_witness_from_files(&dat, &INPUTS, &witness_output_path)
            .expect("generate_witness_from_files failed.");

        let inputs_json = std::fs::read_to_string(&*INPUTS)
            .unwrap_or_else(|_| panic!("Failed to read {}.", INPUTS.display()));

        let input = PoqWitnessInput::new(inputs_json)
            .expect("Failed to construct the input for the witness generator.");
        let output = generate_witness(&input).expect("generate_witness failed.");

        let expected = std::fs::read(&witness_output_path).unwrap_or_else(|_| {
            panic!(
                "Failed to read the generated witness from {}.",
                witness_output_path.display()
            )
        });
        assert_eq!(output.iter().as_slice(), expected.as_slice());
    }
}