Cache SRS, split js and web

.github/workflows/halo2-browser-tests.yml

@@ -27,17 +27,20 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 18
-      - name: Build halo2-wasm
-        working-directory: halo2-wasm
-        run: |
-          rustup toolchain install nightly-2023-08-12-x86_64-unknown-linux-gnu
-          rustup component add rust-src --toolchain nightly-2023-08-12-x86_64-unknown-linux-gnu
-          cargo build --target=x86_64-unknown-linux-gnu --verbose
-      - name: Build halo2-lib-js
-        working-directory: halo2-lib-js
-        run: |
-          npm install
-          npm add @axiom-crypto/[email protected]
+      - name: Set all packages to local and build
+        working-directory: ./
+        run: ./scripts/toggleLocal.sh ci
+      # - name: Build halo2-wasm
+      #   working-directory: halo2-wasm
+      #   run: |
+      #     rustup toolchain install nightly-2023-08-12-x86_64-unknown-linux-gnu
+      #     rustup component add rust-src --toolchain nightly-2023-08-12-x86_64-unknown-linux-gnu
+      #     cargo build --target=x86_64-unknown-linux-gnu --verbose
+      # - name: Build halo2-lib-js
+      #   working-directory: halo2-lib-js
+      #   run: |
+      #     npm install
+      #     npm add @axiom-crypto/[email protected]
       - name: Test halo2-lib-js/halo2-wasm VK equivalence
         working-directory: halo2-lib-js
         run: npm run test:vk

cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axiom-crypto/halo2-wasm-cli",
-  "version": "0.1.6-rc.0",
+  "version": "0.1.7-alpha.0",
   "description": "Halo2 Javascript library",
   "main": "index.js",
   "scripts": {
@@ -18,8 +18,8 @@
   "author": "Intrinsic Technologies",
   "license": "ISC",
   "dependencies": {
-    "@axiom-crypto/halo2-lib-js": "0.2.14-rc.0",
-    "@axiom-crypto/halo2-wasm": "0.2.11-rc.1",
+    "@axiom-crypto/halo2-lib-js": "0.2.15-alpha.0",
+    "@axiom-crypto/halo2-wasm": "0.2.12-alpha.0",
     "commander": "^11.1.0",
     "typescript": "^5.2.2"
   },

cli/scripts/toggleLocal.js

@@ -1,9 +1,15 @@
 const fs = require('fs');
 const packageJson = require('../package.json');
 
+let ci = false;
+if (process.argv[2] === "ci") {
+    ci = true;
+}
+const local = ci ? "file:" : "link:";
+
 const main = () => {
     const packageJsonCopy = { ...packageJson };
-    packageJsonCopy.dependencies['@axiom-crypto/halo2-wasm'] = 'link:../halo2-wasm/pkg';
+    packageJsonCopy.dependencies['@axiom-crypto/halo2-wasm'] = `${local}../halo2-wasm/pkg`;
     fs.writeFileSync('./package.json', JSON.stringify(packageJsonCopy, null, 2));
 }
 

halo2-lib-js/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@axiom-crypto/halo2-lib-js",
-  "version": "0.2.14-rc.0",
+  "version": "0.2.16-rc2.0",
   "description": "Halo2 Javascript library",
   "main": "index.js",
   "scripts": {
     "build": "rm -rf ./dist && tsc && node ./scripts/postTsc.js && pnpm build:docs",
     "build:docs": "./node_modules/.bin/dts-bundle-generator ./dist/halo2lib/functions.d.ts -o src/shared/build.d.ts && node ./scripts/convertDTs.js && rm -rf ./src/shared/build.d.ts",
     "test:vk": "./tests/test_vk.sh",
-    "test:constant": "./tests/test_constant.sh" 
+    "test:constant": "./tests/test_constant.sh"
   },
   "keywords": [
     "axiom",
@@ -32,11 +32,11 @@
     "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@axiom-crypto/halo2-wasm": "0.2.11-rc.1",
+    "@axiom-crypto/halo2-wasm": "link:../halo2-wasm/pkg",
     "ethers": "^6.8.0",
     "prettier": "1.18.2"
   },
   "publishConfig": {
     "directory": "dist"
   }
-}
+}

halo2-lib-js/scripts/toggleLocal.js

@@ -1,9 +1,15 @@
 const fs = require('fs');
 const packageJson = require('../package.json');
 
+let ci = false;
+if (process.argv[2] === "ci") {
+    ci = true;
+}
+const local = ci ? "file:" : "link:";
+
 const main = () => {
     const packageJsonCopy = { ...packageJson };
-    packageJsonCopy.dependencies['@axiom-crypto/halo2-wasm'] = 'link:../halo2-wasm/pkg';
+    packageJsonCopy.dependencies['@axiom-crypto/halo2-wasm'] = `${local}../halo2-wasm/pkg`;
     fs.writeFileSync('./package.json', JSON.stringify(packageJsonCopy, null, 2));
 }
 

halo2-lib-js/src/shared/index.ts

@@ -1,2 +1,3 @@
 export { RawCircuitInput, ConstantValue } from './types'
-export { convertRawInput } from './utils'
+export { convertRawInput } from './utils'
+export { BaseCircuitScaffold } from "@axiom-crypto/halo2-wasm/shared/scaffold";

halo2-lib-js/src/wasm/js.ts

@@ -1 +1 @@
-export * from "@axiom-crypto/halo2-wasm/js"
+export * from "@axiom-crypto/halo2-wasm/js/"

halo2-lib-js/src/wasm/web.ts

@@ -1 +1 @@
-export * from "@axiom-crypto/halo2-wasm/web"
+export * from "@axiom-crypto/halo2-wasm/web/"

halo2-repl/scripts/toggleLocal.js

@@ -1,10 +1,16 @@
 const fs = require('fs');
 const packageJson = require('../package.json');
 
+let ci = false;
+if (process.argv[2] === "ci") {
+    ci = true;
+}
+const local = ci ? "file:" : "link:";
+
 const main = () => {
     const packageJsonCopy = { ...packageJson };
-    packageJsonCopy.dependencies['@axiom-crypto/halo2-wasm'] = 'link:../halo2-wasm/pkg';
-    packageJsonCopy.dependencies['@axiom-crypto/halo2-lib-js'] = 'link:../halo2-lib-js/dist';
+    packageJsonCopy.dependencies['@axiom-crypto/halo2-wasm'] = `${local}../halo2-wasm/pkg`;
+    packageJsonCopy.dependencies['@axiom-crypto/halo2-lib-js'] = `${local}../halo2-lib-js/dist`;
     fs.writeFileSync('./package.json', JSON.stringify(packageJsonCopy, null, 2));
 }
 

halo2-wasm/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "halo2-wasm"
-version = "0.2.11-rc.1"
+version = "0.2.13-rc2.0"
 edition = "2021"
 
 [lib]

halo2-wasm/js/js/index.ts

@@ -1,13 +1,38 @@
 import {
-  Halo2Wasm, initPanicHook, Halo2LibWasm, CircuitConfig,
-  Bn254FqPoint, Bn254G1AffinePoint, Bn254G2AffinePoint, JsCircuitBn254Fq2, JsCircuitBn254G1Affine, JsCircuitBn254G2Affine, JsCircuitSecp256k1Affine, JsCircuitValue256, Secp256k1AffinePoint
+  Halo2Wasm,
+  initPanicHook,
+  Halo2LibWasm,
+  CircuitConfig,
+  Bn254FqPoint,
+  Bn254G1AffinePoint,
+  Bn254G2AffinePoint,
+  JsCircuitBn254Fq2,
+  JsCircuitBn254G1Affine,
+  JsCircuitBn254G2Affine,
+  JsCircuitSecp256k1Affine,
+  JsCircuitValue256,
+  Secp256k1AffinePoint,
 } from "../../pkg/js/halo2_wasm";
-import { getKzgParams } from "../kzg";
+import { getKzgParams } from "./kzg";
 import { DEFAULT_CIRCUIT_CONFIG } from "../shared";
 import { BaseCircuitScaffold } from "../shared/scaffold";
 
-export { CircuitConfig, DEFAULT_CIRCUIT_CONFIG, Halo2Wasm, Halo2LibWasm, getKzgParams };
-export { Bn254FqPoint, Bn254G1AffinePoint, Bn254G2AffinePoint, JsCircuitBn254Fq2, JsCircuitBn254G1Affine, JsCircuitBn254G2Affine, JsCircuitSecp256k1Affine, JsCircuitValue256, Secp256k1AffinePoint };
+export {
+  CircuitConfig,
+  DEFAULT_CIRCUIT_CONFIG,
+  Halo2Wasm,
+  Halo2LibWasm,
+  getKzgParams,
+  Bn254FqPoint,
+  Bn254G1AffinePoint,
+  Bn254G2AffinePoint,
+  JsCircuitBn254Fq2,
+  JsCircuitBn254G1Affine,
+  JsCircuitBn254G2Affine,
+  JsCircuitSecp256k1Affine,
+  JsCircuitValue256,
+  Secp256k1AffinePoint
+};
 
 export const getHalo2Wasm = () => {
   initPanicHook();
@@ -22,12 +47,11 @@ export const getHalo2LibWasm = (halo2wasm: Halo2Wasm) => {
 
 export abstract class CircuitScaffold extends BaseCircuitScaffold {
   constructor(options?: { config?: CircuitConfig, shouldTime?: boolean }) {
-    super()
+    super();
     this.halo2wasm = getHalo2Wasm();
     this.config = options?.config ?? { ...DEFAULT_CIRCUIT_CONFIG };
     this.shouldTime = options?.shouldTime ?? false;
     this.loadedVk = false;
     this.halo2wasm.config(this.config);
   }
-
 }

halo2-wasm/js/js/kzg.ts

@@ -0,0 +1,32 @@
+import * as os from "os";
+import * as path from "path";
+import * as fs from "fs";
+import { fetchAndConvertToUint8Array } from "../shared/utils";
+
+export const getKzgParams = async (k: number): Promise<Uint8Array> => {
+  const home = os.homedir();
+  const axiomSrsPath = path.join(
+    home,
+    ".axiom",
+    "srs",
+    "challenge_0085",
+    `kzg_bn254_${k}.srs`
+  );
+  const exists = fs.existsSync(axiomSrsPath);
+  if (exists) {
+    const buffer = fs.readFileSync(axiomSrsPath);
+    return new Uint8Array(buffer);
+  }
+  const folderPath = path.dirname(axiomSrsPath);
+  if (!fs.existsSync(folderPath)) {
+    fs.mkdirSync(folderPath, { recursive: true });
+  }
+  if (k < 6 || k > 19) {
+    throw new Error(`k=${k} is not supported`);
+  }
+  const srs = await fetchAndConvertToUint8Array(
+    `https://axiom-crypto.s3.amazonaws.com/challenge_0085/kzg_bn254_${k}.srs`
+  );
+  fs.writeFileSync(axiomSrsPath, srs);
+  return srs;
+};

halo2-wasm/js/shared/index.ts

@@ -4,5 +4,5 @@ export const DEFAULT_CIRCUIT_CONFIG = Object.freeze({
     numLookupAdvice: 1,
     numInstance: 1,
     numLookupBits: 13,
-    numVirtualInstance: 1
+    numVirtualInstance: 1,
 });

halo2-wasm/js/shared/scaffold.ts

@@ -1,12 +1,13 @@
 import { CircuitConfig, Halo2Wasm } from "../../pkg/web/halo2_wasm";
-import { getKzgParams } from "../kzg";
+import { CircuitScaffoldContext } from "./types";
 
 export abstract class BaseCircuitScaffold {
     protected halo2wasm!: Halo2Wasm;
     protected config: CircuitConfig;
     protected shouldTime: boolean;
     protected proof: Uint8Array | null = null;
     protected loadedVk: boolean;
+    protected context: CircuitScaffoldContext;
 
     protected timeStart(name: string) {
         if (this.shouldTime) console.time(name);
@@ -16,13 +17,17 @@ export abstract class BaseCircuitScaffold {
         if (this.shouldTime) console.timeEnd(name);
     }
 
+    protected setContext(context: CircuitScaffoldContext) {
+        this.context = context;
+    }
+
     newCircuitFromConfig(config: CircuitConfig) {
         this.config = config;
         this.halo2wasm.config(config);
     }
 
     async loadParams() {
-        const kzgParams = await getKzgParams(this.config.k);
+        const kzgParams = await this.context.getKzgParams(this.config.k);
         this.halo2wasm.loadParams(kzgParams);
     }
 
@@ -109,6 +114,4 @@ export abstract class BaseCircuitScaffold {
         const blob = new Blob([proofHex], { type: "text/plain" });
         return blob;
     }
-
-
 }

halo2-wasm/js/shared/types.ts

@@ -0,0 +1,3 @@
+export interface CircuitScaffoldContext {
+  getKzgParams: (k: number) => Promise<Uint8Array>;
+}