v0.0.8: add auto backend; add Dockerfile

Dockerfile

@@ -0,0 +1,9 @@
+FROM node:16-buster
+WORKDIR /data
+RUN apt update && apt install -y libgmp-dev nlohmann-json3-dev nasm g++
+RUN rm -rf /var/lib/apt/lists/*
+COPY package.json package-lock.json /data
+COPY dist /data/dist
+RUN npm install .
+ENTRYPOINT ["node", "./dist/cli.js"]
+CMD ["--version"]

cli.ts

@@ -5,15 +5,15 @@ import { Command } from 'commander';
 async function main() {
   try {
     const program = new Command();
-    program.version('0.0.7');
+    program.version('0.0.8');
 
     program
       .command('compile <circuit_dir>')
       .description('compile a circom circuit dir')
       .option('-f, --force_recompile', 'ignore compiled files', false)
       .option('-s, --sanity_check', 'check constraints when generate witness', false)
       .option('-v, --verbose', 'print verbose log', false)
-      .option('-b, --backend <string>', 'native or wasm', 'native')
+      .option('-b, --backend <string>', 'native|wasm|auto', 'auto')
       .action(async (circuit_dir, options) => {
         await compileCircuitDir(circuit_dir, {
           alwaysRecompile: options.force_recompile,
@@ -30,7 +30,7 @@ async function main() {
       .option('-f, --force_recompile', 'ignore compiled files', false)
       .option('-s, --sanity_check', 'check constraints when generate witness', false)
       .option('-v, --verbose', 'print verbose log', false)
-      .option('-b, --backend <string>', 'native or wasm', 'native')
+      .option('-b, --backend <string>', 'native|wasm|auto', 'auto')
       .option('-w, --witness_type <string>', 'bin or text', 'text')
       .description('test a circom circuit with given inputs/outputs')
       .action(async (circuit_dir, options) => {

dist/src/witness_generator.d.ts

@@ -26,6 +26,7 @@ declare class WitnessGenerator {
         verbose: boolean;
         sanityCheck: boolean;
     });
+    chooseBackend(): Promise<"native" | "wasm">;
     compile(circuitDirName: any): Promise<{
         r1csFilepath: string;
         symFilepath: string;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "snarkit",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "A command line tool to test circom circuit with given inputs/outputs",
   "main": "./dist/index.js",
   "bin": {
@@ -9,7 +9,8 @@
   "build": "npx tsc",
   "scripts": {
     "fmt": "npx prettier --write \"**/*.{js,ts}\"",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "docker": "docker buildx build --platform linux/amd64 --load -t fluidex/snarkit ."
   },
   "repository": {
     "type": "git",

src/witness_generator.ts

@@ -172,24 +172,28 @@ class WitnessGenerator {
     }
   }
 
+  async chooseBackend() {
+    const needFeatures = ['bmi2', 'adx'];
+    let cpuFeatures = (await si.cpu()).flags.split(/\s/);
+    if (process.platform === 'darwin') {
+      const stdout = shelljs.exec('sysctl machdep.cpu.leaf7_features', { silent: true });
+      const features = stdout.trim().toLowerCase().split(/\s/).slice(1);
+      cpuFeatures.push(...features);
+    }
+    for (const f of needFeatures) {
+      if (!cpuFeatures.includes(f)) {
+        console.log(`cpu missing needed feature ${f} for native backend, fallback to wasm`);
+        console.log(`cpus earlier than Intel Boradwell / AMD Ryzen are not supported for native backend`);
+        return 'wasm';
+      }
+    }
+    return 'native';
+  }
+
   async compile(circuitDirName) {
     this.circuitDirName = path.resolve(circuitDirName);
-    if (this.backend === 'native') {
-      const needFeatures = ['bmi2', 'adx'];
-      let cpuFeatures = (await si.cpu()).flags.split(/\s/);
-      if (process.platform === 'darwin') {
-        const stdout = shelljs.exec('sysctl machdep.cpu.leaf7_features', { silent: true });
-        const features = stdout.trim().toLowerCase().split(/\s/).slice(1);
-        cpuFeatures.push(...features);
-      }
-      for (const f of needFeatures) {
-        if (!cpuFeatures.includes(f)) {
-          console.log(`cpu missing needed feature ${f} for native backend, fallback to wasm`);
-          console.log(`cpus earlier than Intel Boradwell / AMD Ryzen are not supported for native backend`);
-          this.backend = 'wasm';
-          break;
-        }
-      }
+    if (this.backend === 'auto') {
+      this.backend = await this.chooseBackend();
     }
 
     const { r1csFilepath, symFilepath, binaryFilePath } = await compileCircuitDir(this.circuitDirName, {