taceo-circom-types 0.2.5

This crate provides a Rust representation of the types in the `Circom` ecosystem and ways to de/serialize them in a way that is compatible to the existing implementation in snarkjs.
Documentation 
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

use std::{
    fs::File,
    io::{BufReader, BufWriter},
    path::PathBuf,
};

use ark_bn254::Bn254;
use ark_serialize::CanonicalSerialize;
use clap::Parser;
use taceo_circom_types::groth16::ArkZkey;
use taceo_circom_types::{CheckElement, groth16::Zkey};

fn install_tracing() {
    use tracing_subscriber::prelude::*;
    use tracing_subscriber::{
        EnvFilter,
        fmt::{self},
    };

    let fmt_layer = fmt::layer().with_target(false).with_line_number(false);
    let filter_layer = EnvFilter::try_from_default_env()
        .or_else(|_| EnvFilter::try_new("info"))
        .unwrap();

    tracing_subscriber::registry()
        .with(filter_layer)
        .with(fmt_layer)
        .init();
}

/// The configuration for the Zkey Conversion functionality.
///
/// It can be configured via environment variables or command line arguments using `clap`.
#[derive(Parser, Debug)]
pub struct ZkeyConvertConfig {
    /// Path to the zkey.
    #[clap(long, env = "ZKEY_PATH")]
    pub zkey_path: PathBuf,

    /// Output path to the matrices file.
    #[clap(long, env = "MATRICES_PATH")]
    pub matrices_path: Option<PathBuf>,

    /// Output path to the proving key file.
    #[clap(long, env = "PROVING_KEY_PATH")]
    pub pk_path: Option<PathBuf>,

    /// Path to the ark-zkey file.
    #[clap(long, env = "ARKS_ZKEY_PATH", default_value = "arks.zkey")]
    pub arks_zkey_path: PathBuf,

    /// Use uncompressed serialization
    #[clap(long, env = "UNCOMPRESSED")]
    pub uncompressed: bool,
}

fn main() -> eyre::Result<()> {
    install_tracing();
    let config = ZkeyConvertConfig::parse();
    tracing::info!("Converting zkey at {}", config.zkey_path.display());
    let zkey = Zkey::<Bn254>::from_reader(
        BufReader::new(File::open(config.zkey_path)?),
        CheckElement::No,
    )?;
    tracing::info!("Loaded zkey");
    let ark_zkey = ArkZkey::from(zkey);
    tracing::info!("Converted zkey");
    let compress = if config.uncompressed {
        ark_serialize::Compress::No
    } else {
        ark_serialize::Compress::Yes
    };

    if let Some(matrices_path) = &config.matrices_path {
        ark_zkey
            .matrices
            .serialize_with_mode(BufWriter::new(File::create(matrices_path)?), compress)?;
        tracing::info!("Serialized matrices to {}", matrices_path.display());
    }

    if let Some(pk_path) = &config.pk_path {
        ark_zkey
            .pk
            .serialize_with_mode(File::create(pk_path)?, compress)?;
        tracing::info!("Serialized proving key to {}", pk_path.display());
    }

    ark_zkey.serialize_with_mode(File::create(&config.arks_zkey_path)?, compress)?;
    tracing::info!(
        "Serialized arks-zkey to {}",
        config.arks_zkey_path.display()
    );

    Ok(())
}