zisk-common 1.1.0-alpha

Common utilities and shared types for the ZisK zkVM
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

use serde::Serialize;
use std::error::Error;
use std::fs::File;
use std::io::Write;
use std::path::PathBuf;

/// The `ProofLog` struct is designed to capture and serialize information about proof generation,
#[derive(Serialize)]
pub struct ProofLog {
    cycles: u64,
    id: String,
    time: f64,
}

impl ProofLog {
    /// Creates a new `ProofLog` instance with the provided cycle count, identifier, and time.
    pub fn new(cycles: u64, id: String, time: f64) -> Self {
        ProofLog { cycles, id, time }
    }

    /// Writes the proof log entries to a JSON file at the specified path.
    ///
    /// # Errors
    ///
    /// Returns an error if `entries` cannot be serialized to JSON, or if the file
    /// cannot be created or written.
    pub fn write_json_log(file_path: &PathBuf, entries: &ProofLog) -> Result<(), Box<dyn Error>> {
        let json = serde_json::to_string_pretty(entries)?;
        let mut file = File::create(file_path)?;
        file.write_all(json.as_bytes())?;
        Ok(())
    }
}