circom/cli.js

#!/usr/bin/env node

/*
    Copyright 2018 0KIMS association.

    This file is part of circom (Zero Knowledge Circuit Compiler).

    circom is a free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    circom is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
    or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
    License for more details.

    You should have received a copy of the GNU General Public License
    along with circom. If not, see <https://www.gnu.org/licenses/>.
*/

/* eslint-disable no-console */

const fs = require("fs");
const path = require("path");
const Scalar = require("ffjavascript").Scalar;
const stringifyBigInts = require("ffjavascript").utils.stringifyBigInts;
const fastFile = require("fastfile");

const compiler = require("./src/compiler");

const version = require("./package").version;

const argv = require("yargs")
    .version(version)
    .usage("circom [input source circuit file] -r [output r1cs file] -c [output c file] -w [output wasm file] -t [output wat file] -s [output sym file]")
    .alias("o", "output")
    .alias("c", "csource")
    .alias("w", "wasm")
    .alias("t", "wat")
    .alias("s", "sym")
    .alias("r", "r1cs")
    .alias("p", "prime")
    .alias("n", "newThreadTemplates")
    .help("h")
    .alias("h", "help")
    .option("verbose", {
        alias: "v",
        type: "boolean",
        description: "Run with verbose logging"
    })
    .option("fast", {
        alias: "f",
        type: "boolean",
        description: "Do not optimize constraints"
    })
    .epilogue(`Copyright (C) 2018  0kims association
    This program comes with ABSOLUTELY NO WARRANTY;
    This is free software, and you are welcome to redistribute it
    under certain conditions; see the COPYING file in the official
    repo directory at  https://github.com/iden3/circom `)
    .argv;


async function run() {
    let inputFile;
    if (argv._.length == 0) {
        inputFile = "circuit.circom";
    } else if (argv._.length == 1) {
        inputFile = argv._[0];
    } else  {
        console.log("Only one circuit at a time is permited");
        process.exit(1);
    }

    const fullFileName = path.resolve(process.cwd(), inputFile);
    const fileName = path.basename(fullFileName, ".circom");
    const cSourceName = typeof(argv.csource) === "string" ?  argv.csource : fileName + ".cpp";
    const wasmName = typeof(argv.wasm) === "string" ?  argv.wasm : fileName + ".wasm";
    const watName = typeof(argv.wat) === "string" ?  argv.wat : fileName + ".wat";
    const r1csName = typeof(argv.r1cs) === "string" ?  argv.r1cs : fileName + ".r1cs";
    const symName = typeof(argv.sym) === "string" ?  argv.sym : fileName + ".sym";

    const options = {};
    options.reduceConstraints = !argv.fast;
    options.verbose = argv.verbose || false;
    options.sanityCheck = argv.sanitycheck;

    if (argv.csource) {
        options.cSourceFile = await fastFile.createOverride(cSourceName);
        const noExt = cSourceName.substr(0, cSourceName.lastIndexOf(".")) || cSourceName;
        options.dataFile = await fastFile.createOverride(noExt+".dat");
    }
    if (argv.wasm) {
        options.wasmFile = await fastFile.createOverride(wasmName);
    }
    if (argv.wat) {
        options.watFile = await fastFile.createOverride(watName);
    }
    if (argv.r1cs) {
        options.r1csFileName = r1csName;
    }
    if (argv.sym) {
        options.symWriteStream = fs.createWriteStream(symName);
    }
    if (argv.newThreadTemplates) {
        options.newThreadTemplates = new RegExp(argv.newThreadTemplates);
    }
    if (!argv.prime) {
        options.prime = Scalar.fromString("21888242871839275222246405745257275088548364400416034343698204186575808495617");
    } else if (["BLS12-381", "BLS12381"]. indexOf(argv.prime.toUpperCase()) >=0) {
        options.prime = Scalar.fromString("73eda753299d7d483339d80809a1d80553bda402fffe5bfeffffffff00000001",16);
    } else if (["BN-128", "BN128", "BN254", "BN-254"]. indexOf(argv.prime.toUpperCase()) >=0) {
        options.prime = Scalar.fromString("21888242871839275222246405745257275088548364400416034343698204186575808495617");
    } else {
        options.prime = Scalar.fromString(argv.prime);
    }


    await compiler(fullFileName, options);

    if (options.cSourceFile) await options.cSourceFile.close();
    if (options.dataFile) await options.dataFile.close();
    if (options.wasmFile) await options.wasmFile.close();
    if (options.watFile) await options.watFile.close();
    let symDone = false;
    if (options.symWriteStream) {
        options.symWriteStream.on("finish", () => {
            symDone = true;
            finishIfDone();
        });
    } else {
        symDone = true;
    }
    function finishIfDone() {
        if (symDone) {
            setTimeout(() => {
                process.exit(0);
            }, 300);
        }
    }

}

run().then(()=> {
    process.exit(0);
}, (err) => {
//    console.log(err);
    console.log(err.stack);
    if (err.pos) {
        console.error(`ERROR at ${err.errFile}:${err.pos.first_line},${err.pos.first_column}-${err.pos.last_line},${err.pos.last_column}   ${err.errStr}`);
    } else {
        console.log(err.message);
        if (argv.verbose) console.log(err.stack);
    }
    if (err.ast) {
        console.error(JSON.stringify(stringifyBigInts(err.ast), null, 1));
    }
    process.exit(1);
});