build(identity): config rollup to handle browser bundle

re #481


Former-commit-id: 12cc55c

Author: cedoor

packages/cli/package.json

@@ -24,7 +24,6 @@
     },
     "scripts": {
         "start": "node --loader ts-node/esm --no-warnings src/index.ts",
-        "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
         "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
         "prepublishOnly": "yarn build"
     },

packages/cli/rollup.config.ts

@@ -18,7 +18,7 @@ const banner = `#!/usr/bin/env node
 export default {
     input: "src/index.ts",
     output: [{ file: pkg.bin.semaphore, format: "es", banner }],
-    external: ["url", "fs", "path", ...Object.keys(pkg.dependencies)],
+    external: [...Object.keys(pkg.dependencies), "url", "fs", "path", "child_process"],
     plugins: [
         (typescript as any)({
             tsconfig: "./build.tsconfig.json",

packages/data/package.json

@@ -22,7 +22,6 @@
         "url": "https://github.com/semaphore-protocol/semaphore.git/issues"
     },
     "scripts": {
-        "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
         "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
         "prepublishOnly": "yarn build"
     },
@@ -35,7 +34,7 @@
         "rollup-plugin-typescript2": "^0.31.2"
     },
     "dependencies": {
-        "axios": "^0.27.2",
+        "axios": "1.6.6",
         "ethers": "6.10.0"
     }
 }

packages/group/package.json

@@ -22,7 +22,6 @@
         "url": "https://github.com/semaphore-protocol/semaphore.git/issues"
     },
     "scripts": {
-        "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
         "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
         "prepublishOnly": "yarn build"
     },

packages/hardhat/package.json

@@ -22,7 +22,6 @@
         "url": "https://github.com/semaphore-protocol/semaphore.git/issues"
     },
     "scripts": {
-        "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
         "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
         "prepublishOnly": "yarn build"
     },

packages/hardhat/rollup.config.ts

@@ -18,7 +18,7 @@ export default {
         { file: pkg.exports.require, format: "cjs", banner, exports: "auto" },
         { file: pkg.exports.import, format: "es", banner }
     ],
-    external: Object.keys(pkg.dependencies),
+    external: [...Object.keys(pkg.dependencies), "hardhat/config"],
     plugins: [
         typescript({
             tsconfig: "./build.tsconfig.json",

packages/heyauthn/package.json

@@ -22,7 +22,6 @@
         "url": "https://github.com/semaphore-protocol/semaphore.git/issues"
     },
     "scripts": {
-        "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
         "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
         "prepublishOnly": "yarn build"
     },

packages/identity/package.json

@@ -4,10 +4,17 @@
     "description": "A library to create Semaphore identities.",
     "license": "MIT",
     "main": "dist/index.node.js",
+    "browser": "dist/index.browser.mjs",
     "exports": {
-        "import": "./dist/index.mjs",
-        "require": "./dist/index.node.js",
-        "types": "./dist/types/index.d.ts"
+        ".": {
+            "node": {
+                "import": "./dist/index.node.mjs",
+                "require": "./dist/index.node.js"
+            },
+            "browser": "./dist/index.browser.mjs",
+            "default": "./dist/index.browser.mjs",
+            "types": "./dist/types/index.d.ts"
+        }
     },
     "types": "dist/types/index.d.ts",
     "files": [
@@ -22,14 +29,16 @@
         "url": "https://github.com/semaphore-protocol/semaphore.git/issues"
     },
     "scripts": {
-        "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
-        "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
+        "build": "rimraf dist && yarn build:browser && yarn build:node",
+        "build:browser": "rollup -c rollup.browser.config.ts --configPlugin typescript",
+        "build:node": "rollup -c rollup.node.config.ts --configPlugin typescript",
         "prepublishOnly": "yarn build"
     },
     "publishConfig": {
         "access": "public"
     },
     "devDependencies": {
+        "@rollup/plugin-alias": "^5.1.0",
         "@rollup/plugin-commonjs": "^24.0.1",
         "@rollup/plugin-node-resolve": "^15.0.1",
         "rollup-plugin-cleanup": "^3.2.1",

packages/identity/rollup.browser.config.ts

@@ -0,0 +1,38 @@
+import alias from "@rollup/plugin-alias"
+import json from "@rollup/plugin-json"
+import * as fs from "fs"
+import cleanup from "rollup-plugin-cleanup"
+import typescript from "rollup-plugin-typescript2"
+
+const pkg = JSON.parse(fs.readFileSync("./package.json", "utf-8"))
+const banner = `/**
+ * @module ${pkg.name}
+ * @version ${pkg.version}
+ * @file ${pkg.description}
+ * @copyright Ethereum Foundation 2024
+ * @license ${pkg.license}
+ * @see [Github]{@link ${pkg.homepage}}
+*/`
+
+export default {
+    input: "src/index.ts",
+    output: [
+        {
+            file: pkg.exports.browser,
+            format: "es",
+            banner
+        }
+    ],
+    external: [...Object.keys(pkg.dependencies), "poseidon-lite/poseidon2"],
+    plugins: [
+        alias({
+            entries: [{ find: "./random-number.node", replacement: "./random-number.browser" }]
+        }),
+        typescript({
+            tsconfig: "./build.tsconfig.json",
+            useTsconfigDeclarationDir: true
+        }),
+        cleanup({ comments: "jsdoc" }),
+        json()
+    ]
+}

packages/identity/rollup.config.ts renamed to packages/identity/rollup.node.config.ts

@@ -1,8 +1,6 @@
-import typescript from "rollup-plugin-typescript2"
-import commonjs from "@rollup/plugin-commonjs"
 import * as fs from "fs"
 import cleanup from "rollup-plugin-cleanup"
-import { nodeResolve } from "@rollup/plugin-node-resolve"
+import typescript from "rollup-plugin-typescript2"
 
 const pkg = JSON.parse(fs.readFileSync("./package.json", "utf-8"))
 const banner = `/**
@@ -17,17 +15,15 @@ const banner = `/**
 export default {
     input: "src/index.ts",
     output: [
-        { file: pkg.exports.require, format: "cjs", banner, exports: "auto" },
-        { file: pkg.exports.import, format: "es", banner }
+        { file: pkg.exports.node.require, format: "cjs", banner, exports: "auto" },
+        { file: pkg.exports.node.import, format: "es", banner }
     ],
-    external: Object.keys(pkg.dependencies),
+    external: [...Object.keys(pkg.dependencies), "poseidon-lite/poseidon2", "node:crypto"],
     plugins: [
         typescript({
             tsconfig: "./build.tsconfig.json",
             useTsconfigDeclarationDir: true
         }),
-        commonjs(),
-        nodeResolve(),
         cleanup({ comments: "jsdoc" })
     ]
 }

packages/identity/src/bytes-to-bigint.ts

@@ -0,0 +1,9 @@
+export function bytesToBigint(bytes: Uint8Array): bigint {
+    let hex = "0x"
+
+    for (let i = 0; i < bytes.length; i += 1) {
+        hex += bytes[i].toString(16).padStart(2, "0")
+    }
+
+    return BigInt(hex)
+}

packages/identity/src/identity.ts

@@ -7,8 +7,8 @@ import {
     signMessage,
     verifySignature
 } from "@zk-kit/eddsa-poseidon"
-import { randomBytes } from "crypto"
 import { poseidon2 } from "poseidon-lite/poseidon2"
+import { randomNumber } from "./random-number.node"
 
 export default class Identity {
     private _privateKey: BigNumberish
@@ -20,7 +20,7 @@ export default class Identity {
      * Initializes the class attributes based on the parameters.
      * @param privateKey The secret value used to generate an EdDSA public key.
      */
-    constructor(privateKey: BigNumberish = BigInt(`0x${randomBytes(32).toString("hex")}`).toString()) {
+    constructor(privateKey: BigNumberish = randomNumber().toString()) {
         this._privateKey = privateKey
         this._secretScalar = deriveSecretScalar(privateKey)
 

packages/identity/src/random-number.browser.ts

@@ -0,0 +1,8 @@
+/* istanbul ignore file */
+import { bytesToBigint } from "./bytes-to-bigint"
+
+export function randomNumber(): bigint {
+    const bytes = crypto.getRandomValues(new Uint8Array(32))
+
+    return bytesToBigint(bytes)
+}

packages/identity/src/random-number.node.ts

@@ -0,0 +1,9 @@
+import { randomBytes } from "node:crypto"
+
+export function randomNumber(): bigint {
+    const bytes = randomBytes(32)
+
+    const hex = `0x${bytes.toString("hex")}`
+
+    return BigInt(hex)
+}

packages/identity/tests/index.test.ts

@@ -1,4 +1,6 @@
+import { randomBytes } from "crypto"
 import { Identity } from "../src"
+import { bytesToBigint } from "../src/bytes-to-bigint"
 
 describe("Identity", () => {
     const privateKey = "secret"
@@ -60,4 +62,15 @@ describe("Identity", () => {
             expect(Identity.verifySignature("message", signature, identity.publicKey)).toBeTruthy()
         })
     })
+
+    describe("# bytesToBigint", () => {
+        it("Should convert 32 bytes to bigint", () => {
+            const bytes = randomBytes(32)
+
+            const integer = bytesToBigint(bytes)
+
+            expect(typeof integer).toBe("bigint")
+            expect(integer).toBe(BigInt(`0x${bytes.toString("hex")}`))
+        })
+    })
 })

packages/identity/tsconfig.json

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

packages/proof/package.json

@@ -4,14 +4,17 @@
     "description": "A library to generate and verify Semaphore proofs.",
     "license": "MIT",
     "main": "dist/index.node.js",
+    "browser": "dist/index.browser.mjs",
     "exports": {
-        "node": {
-            "import": "./dist/index.node.mjs",
-            "require": "./dist/index.node.js"
-        },
-        "browser": "./dist/index.browser.mjs",
-        "default": "./dist/index.browser.mjs",
-        "types": "./dist/types/index.d.ts"
+        ".": {
+            "node": {
+                "import": "./dist/index.node.mjs",
+                "require": "./dist/index.node.js"
+            },
+            "browser": "./dist/index.browser.mjs",
+            "default": "./dist/index.browser.mjs",
+            "types": "./dist/types/index.d.ts"
+        }
     },
     "types": "dist/types/index.d.ts",
     "files": [

packages/proof/rollup.node.config.ts

@@ -28,7 +28,7 @@ export default {
             banner
         }
     ],
-    external: Object.keys(pkg.dependencies),
+    external: [...Object.keys(pkg.dependencies), "fs"],
     plugins: [
         typescript({
             tsconfig: "./build.tsconfig.json",

packages/proof/tsconfig.json

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

yarn.lock.REMOVED.git-id

@@ -1 +1 @@
-d3dec95f38eaf98de105a46c8b2a023337c9360e
+a1f836136a63bf31ff94a3476fe812378036cc2a