Merge pull request #193 from privacy-scaling-explorations/ref/browser…

…-compatible

Improve `@zk-kit/utils` package

jest.config.ts

@@ -1,7 +1,7 @@
 import fs from "fs"
 import type { Config } from "@jest/types"
 
-const exclude = ["circuits", "imt.sol", "rollup-plugin-rust", "lazytower.sol", "lazytower.circom", "utils"]
+const exclude = ["circuits", "imt.sol", "rollup-plugin-rust", "lazytower.sol", "lazytower.circom"]
 
 const projects: any = fs
     .readdirSync("./packages", { withFileTypes: true })

packages/baby-jubjub/package.json

@@ -28,15 +28,13 @@
         "url": "https://github.com/privacy-scaling-explorations/zk-kit.git/issues"
     },
     "scripts": {
-        "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript && yarn build:iife",
-        "build:iife": "rollup -c rollup.iife.config.ts --configPlugin typescript",
+        "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
         "prepublishOnly": "yarn build"
     },
     "publishConfig": {
         "access": "public"
     },
     "devDependencies": {
-        "@rollup/plugin-commonjs": "^25.0.7",
         "@rollup/plugin-node-resolve": "^15.2.3",
         "@rollup/plugin-terser": "^0.4.4",
         "@rollup/plugin-typescript": "^11.1.6",

packages/baby-jubjub/rollup.config.ts

@@ -1,6 +1,7 @@
 import typescript from "@rollup/plugin-typescript"
 import fs from "fs"
 import cleanup from "rollup-plugin-cleanup"
+import terser from "@rollup/plugin-terser"
 
 const pkg = JSON.parse(fs.readFileSync("./package.json", "utf8"))
 const banner = `/**
@@ -12,11 +13,25 @@ const banner = `/**
  * @see [Github]{@link ${pkg.homepage}}
 */`
 
+const name = pkg.name.split("/")[1].replace(/[-/]./g, (x: string) => x.toUpperCase()[1])
+
 export default {
     input: "src/index.ts",
     output: [
         { file: pkg.exports["."].require, format: "cjs", banner },
-        { file: pkg.exports["."].default, format: "es", banner }
+        { file: pkg.exports["."].default, format: "es", banner },
+        {
+            file: pkg.iife,
+            name,
+            format: "iife",
+            banner
+        },
+        {
+            file: pkg.unpkg,
+            name,
+            format: "iife",
+            plugins: [terser({ output: { preamble: banner } })]
+        }
     ],
     external: Object.keys(pkg.dependencies),
     plugins: [typescript({ tsconfig: "./build.tsconfig.json" }), cleanup({ comments: "jsdoc" })]

packages/baby-jubjub/tsconfig.json

@@ -1,4 +1,4 @@
 {
     "extends": "../../tsconfig.json",
-    "include": ["src", "tests", "rollup.config.ts", "rollup.iife.config.ts"]
+    "include": ["src", "tests", "rollup.config.ts"]
 }

packages/circuits/package.json

@@ -26,6 +26,7 @@
         "@zk-kit/eddsa-poseidon": "0.5.1",
         "@zk-kit/poseidon-cipher": "0.1.1",
         "@zk-kit/smt": "1.0.0",
+        "@zk-kit/utils": "0.5.0",
         "circomkit": "0.0.24",
         "mocha": "^10.2.0",
         "poseidon-lite": "^0.2.0"

packages/circuits/tests/common.ts

@@ -1,8 +1,7 @@
 import { Circomkit } from "circomkit"
 import { readFileSync } from "fs"
 import path from "path"
-import { randomBytes } from "crypto"
-import { Point, mulPointEscalar, r } from "@zk-kit/baby-jubjub"
+import { Point, mulPointEscalar } from "@zk-kit/baby-jubjub"
 import { derivePublicKey, deriveSecretScalar } from "@zk-kit/eddsa-poseidon"
 import { LeanIMT } from "@zk-kit/imt"
 import { poseidon2 } from "poseidon-lite"
@@ -34,34 +33,6 @@ export const circomkit = new Circomkit({
     verbose: false
 })
 
-/**
- * Returns a BabyJub-compatible random value. We create it by first generating
- * a random value (initially 256 bits large) modulo the snark field size as
- * described in EIP197. This results in a key size of roughly 253 bits and no
- * more than 254 bits. To prevent modulo bias, we then use this efficient
- * algorithm:
- * http://cvsweb.openbsd.org/cgi-bin/cvsweb/~checkout~/src/lib/libc/crypt/arc4random_uniform.c
- * @returns A BabyJub-compatible random value.
- */
-export const genRandomBabyJubValue = (): bigint => {
-    // Prevent modulo bias
-    // const lim = BigInt('0x10000000000000000000000000000000000000000000000000000000000000000')
-    // const min = (lim - SNARK_FIELD_SIZE) % SNARK_FIELD_SIZE
-    const min = BigInt("6350874878119819312338956282401532410528162663560392320966563075034087161851")
-
-    let privKey: bigint = r
-
-    do {
-        const rand = BigInt(`0x${randomBytes(32).toString("hex")}`)
-
-        if (rand >= min) {
-            privKey = rand % r
-        }
-    } while (privKey >= r)
-
-    return privKey
-}
-
 /**
  * Generate a public key from a private key
  * @param privateKey the private key to generate a public key from

packages/circuits/tests/ecdh.test.ts

@@ -1,7 +1,7 @@
 import { WitnessTester } from "circomkit"
 import { deriveSecretScalar } from "@zk-kit/eddsa-poseidon"
-
-import { circomkit, genEcdhSharedKey, genPublicKey, genRandomBabyJubValue } from "./common"
+import { beBufferToBigInt, crypto } from "@zk-kit/utils"
+import { circomkit, genEcdhSharedKey, genPublicKey } from "./common"
 
 describe("ECDH Shared Key derivation circuit", () => {
     let circuit: WitnessTester<["privateKey", "publicKey"], ["sharedKey"]>
@@ -14,38 +14,43 @@ describe("ECDH Shared Key derivation circuit", () => {
     })
 
     it("should correctly compute an ECDH shared key", async () => {
-        const privateKey1 = genRandomBabyJubValue()
-        const privateKey2 = genRandomBabyJubValue()
-        const publicKey2 = genPublicKey(privateKey2)
+        const privateKey1 = crypto.getRandomValues(32)
+        const privateKey2 = crypto.getRandomValues(32)
+        const bgPrivateKey1 = beBufferToBigInt(Buffer.from(privateKey1))
+        const bgPrivateKey2 = beBufferToBigInt(Buffer.from(privateKey2))
+
+        const publicKey2 = genPublicKey(bgPrivateKey2)
 
         // generate a shared key between the first private key and the second public key
-        const ecdhSharedKey = genEcdhSharedKey(privateKey1, publicKey2)
+        const ecdhSharedKey = genEcdhSharedKey(bgPrivateKey1, publicKey2)
 
         const circuitInputs = {
-            privateKey: BigInt(deriveSecretScalar(privateKey1)),
+            privateKey: BigInt(deriveSecretScalar(bgPrivateKey1)),
             publicKey: publicKey2
         }
 
         await circuit.expectPass(circuitInputs, { sharedKey: [ecdhSharedKey[0], ecdhSharedKey[1]] })
     })
 
     it("should generate the same shared key from the same keypairs", async () => {
-        const privateKey1 = genRandomBabyJubValue()
-        const privateKey2 = genRandomBabyJubValue()
-        const publicKey1 = genPublicKey(privateKey1)
-        const publicKey2 = genPublicKey(privateKey2)
+        const privateKey1 = crypto.getRandomValues(32)
+        const privateKey2 = crypto.getRandomValues(32)
+        const bgPrivateKey1 = beBufferToBigInt(Buffer.from(privateKey1))
+        const bgPrivateKey2 = beBufferToBigInt(Buffer.from(privateKey2))
+        const publicKey1 = genPublicKey(bgPrivateKey1)
+        const publicKey2 = genPublicKey(bgPrivateKey2)
 
         // generate a shared key between the first private key and the second public key
-        const ecdhSharedKey = genEcdhSharedKey(privateKey1, publicKey2)
-        const ecdhSharedKey2 = genEcdhSharedKey(privateKey2, publicKey1)
+        const ecdhSharedKey = genEcdhSharedKey(bgPrivateKey1, publicKey2)
+        const ecdhSharedKey2 = genEcdhSharedKey(bgPrivateKey2, publicKey1)
 
         const circuitInputs = {
-            privateKey: BigInt(deriveSecretScalar(privateKey1)),
+            privateKey: BigInt(deriveSecretScalar(bgPrivateKey1)),
             publicKey: publicKey2
         }
 
         const circuitInputs2 = {
-            privateKey: BigInt(deriveSecretScalar(privateKey2)),
+            privateKey: BigInt(deriveSecretScalar(bgPrivateKey2)),
             publicKey: publicKey1
         }
 
@@ -60,9 +65,9 @@ describe("ECDH Shared Key derivation circuit", () => {
     })
 
     it("should generate the same ECDH key consistently for the same inputs", async () => {
-        const privateKey1 = BigInt(deriveSecretScalar(genRandomBabyJubValue()))
-        const privateKey2 = genRandomBabyJubValue()
-        const publicKey2 = genPublicKey(privateKey2)
+        const privateKey1 = BigInt(deriveSecretScalar(Buffer.from(crypto.getRandomValues(32))))
+        const privateKey2 = crypto.getRandomValues(32)
+        const publicKey2 = genPublicKey(beBufferToBigInt(Buffer.from(privateKey2)))
 
         const circuitInputs = {
             privateKey: privateKey1,

packages/circuits/tests/poseidon-cipher.test.ts

@@ -1,15 +1,16 @@
 import { WitnessTester } from "circomkit"
 import { Nonce, PlainText, poseidonDecrypt, poseidonEncrypt, poseidonPerm } from "@zk-kit/poseidon-cipher"
-
-import { circomkit, genEcdhSharedKey, genPublicKey, genRandomBabyJubValue } from "./common"
+import { beBufferToBigInt, crypto } from "@zk-kit/utils"
+import { circomkit, genEcdhSharedKey, genPublicKey } from "./common"
 
 describe("poseidon-cipher", () => {
     describe("poseidonDecrypt", () => {
         let circuit: WitnessTester<["ciphertext", "nonce", "key"], ["decrypted"]>
 
-        const privateKey = genRandomBabyJubValue()
-        const publicKey = genPublicKey(privateKey)
-        const encryptionKey = genEcdhSharedKey(privateKey, publicKey)
+        const privateKey = crypto.getRandomValues(32)
+        const bgPrivateKey = beBufferToBigInt(Buffer.from(privateKey))
+        const publicKey = genPublicKey(bgPrivateKey)
+        const encryptionKey = genEcdhSharedKey(bgPrivateKey, publicKey)
 
         const nonce: Nonce = BigInt(5)
 
@@ -96,9 +97,10 @@ describe("poseidon-cipher", () => {
     describe("poseidonDecryptWithoutChecks", () => {
         let circuit: WitnessTester<["ciphertext", "nonce", "key"], ["decrypted"]>
 
-        const privateKey = genRandomBabyJubValue()
-        const publicKey = genPublicKey(privateKey)
-        const encryptionKey = genEcdhSharedKey(privateKey, publicKey)
+        const privateKey = crypto.getRandomValues(32)
+        const bgPrivateKey = beBufferToBigInt(Buffer.from(privateKey))
+        const publicKey = genPublicKey(bgPrivateKey)
+        const encryptionKey = genEcdhSharedKey(bgPrivateKey, publicKey)
 
         const plainText: PlainText<bigint> = [BigInt(0), BigInt(1)]
         const nonce: Nonce = BigInt(5)
@@ -153,9 +155,10 @@ describe("poseidon-cipher", () => {
     describe("poseidonIterations", () => {
         let circuit: WitnessTester<["ciphertext", "nonce", "key"], ["decrypted"]>
 
-        const privateKey = genRandomBabyJubValue()
-        const publicKey = genPublicKey(privateKey)
-        const encryptionKey = genEcdhSharedKey(privateKey, publicKey)
+        const privateKey = crypto.getRandomValues(32)
+        const bgPrivateKey = beBufferToBigInt(Buffer.from(privateKey))
+        const publicKey = genPublicKey(bgPrivateKey)
+        const encryptionKey = genEcdhSharedKey(bgPrivateKey, publicKey)
 
         const plainText: PlainText<bigint> = [BigInt(0), BigInt(1)]
         const nonce: Nonce = BigInt(5)

packages/eddsa-poseidon/package.json

@@ -40,7 +40,6 @@
         "@rollup/plugin-node-resolve": "^15.2.3",
         "@rollup/plugin-terser": "^0.4.4",
         "@rollup/plugin-typescript": "^11.1.6",
-        "blake-hash": "2.0.0",
         "circomlibjs": "0.0.8",
         "ffjavascript": "0.2.38",
         "poseidon-lite": "0.2.0",
@@ -51,6 +50,7 @@
     },
     "dependencies": {
         "@zk-kit/baby-jubjub": "0.2.0",
-        "@zk-kit/utils": "0.5.0"
+        "@zk-kit/utils": "0.5.0",
+        "buffer": "6.0.3"
     }
 }

packages/eddsa-poseidon/rollup.iife.config.ts

@@ -1,10 +1,8 @@
 import commonjs from "@rollup/plugin-commonjs"
-import { nodeResolve } from "@rollup/plugin-node-resolve"
 import terser from "@rollup/plugin-terser"
 import typescript from "@rollup/plugin-typescript"
 import fs from "fs"
 import cleanup from "rollup-plugin-cleanup"
-import nodePolyfills from "rollup-plugin-polyfill-node"
 
 const pkg = JSON.parse(fs.readFileSync("./package.json", "utf8"))
 const banner = `/**
@@ -35,13 +33,5 @@ export default {
         }
     ],
     external: [],
-    plugins: [
-        typescript({ tsconfig: "./build.tsconfig.json" }),
-        commonjs(),
-        nodeResolve({
-            preferBuiltins: true
-        }),
-        nodePolyfills({ include: null }),
-        cleanup({ comments: "jsdoc" })
-    ]
+    plugins: [typescript({ tsconfig: "./build.tsconfig.json" }), commonjs(), cleanup({ comments: "jsdoc" })]
 }