@aztec/bb.js 0.0.1-alpha.6 → 0.0.1-fake-ceab37513c

package/README.md

@@ -8,23 +8,25 @@ project structures.
 Max circuit size is 2^19 gates (524,288). This is due to the underlying WASM 4GB memory limit. This should improve
 with future proving systems, and/or introduction of wasm64.
 
-If running from terminal, or within browser where you can set shared memory COOP/COEP headers, multithreading is enabled.
+If running from node, or within browser where you can set shared memory COOP/COEP headers, multithreading is enabled.
 Note there are two independent WASM builds, one with threading enabled and one without. This is because the shared
 memory flag is set within the WASM itself. If you're running in a context where you can't have shared memory, we want
 to fallback to single threaded performance.
 
-Performance for 2^19 (small witness generation phase):
+Table represents time in ms to build circuit and proof for each test on n threads.
+Ignores proving key construction.
 
-- 16 core x86: ~13s.
-- 10 core M1 Mac Pro: ~18s.
-
-Linear scaling was observed up to 32 cores, however we limit to 16 as 2^19 runs out of memory with 32 cores.
-This maybe resolvable.
-
-Witness generation phase is not multithreaded, and an interesting 512k circuit can take ~12s. This results in:
-
-- 16 core x86: ~26s.
-- 10 core M1 Mac Pro: (TBD)
+```
++--------------------------+------------+---------------+-----------+-----------+-----------+-----------+-----------+
+| Test                     | Gate Count | Subgroup Size |         1 |         4 |        16 |        32 |        64 |
++--------------------------+------------+---------------+-----------+-----------+-----------+-----------+-----------+
+| sha256                   | 38799      | 65536         |     18764 |      5116 |      1854 |      1524 |      1635 |
+| ecdsa_secp256k1          | 41049      | 65536         |     19129 |      5595 |      2255 |      2097 |      2166 |
+| ecdsa_secp256r1          | 67331      | 131072        |     38815 |     11257 |      4744 |      3633 |      3702 |
+| schnorr                  | 33740      | 65536         |     18649 |      5244 |      2019 |      1498 |      1702 |
+| double_verify_proof      | 505513     | 524288        |    149652 |     45702 |     20811 |     16979 |     15679 |
++--------------------------+------------+---------------+-----------+-----------+-----------+-----------+-----------+
+```
 
 ## Using as a standalone binary
 
@@ -33,10 +35,10 @@ Witness generation phase is not multithreaded, and an interesting 512k circuit c
 To install the package globally for running as a terminal application:
 
 ```
-npm install -g @aztec/bb.js@alpha
+npm install -g @aztec/bb.js
 ```
 
-This will install `bb.js` into your path.
+Assuming `$(npm prefix -g)/bin` is in your `PATH`, you can now run the command `bb.js`.
 
 ### Usage
 
@@ -58,7 +60,7 @@ Commands:
   contract [options]          Output solidity verification key contract.
   write_vk [options]          Output verification key.
   proof_as_fields [options]   Return the proof as fields elements
-  vk_as_fields [options]      Return the verifiation key represented as fields elements. Also return the verification key hash.
+  vk_as_fields [options]      Return the verification key represented as field elements. Also return the verification key hash.
   help [command]              display help for command
 ```
 
@@ -69,53 +71,87 @@ Commands:
 To install as a package to be used as a library:
 
 ```
-npm install @aztec/bb.js@alpha
+npm install @aztec/bb.js
 ```
 
 or with yarn
 
 ```
-yarn add @aztec/bb.js@alpha
+yarn add @aztec/bb.js
 ```
 
 ### Usage
 
-To create a multithreaded version of the API:
+To create the API and do a blake2s hash:
 
 ```typescript
-const api = await newBarretenbergApiAsync(/* num_threads */);
-// Use.
+import { Crs, Barretenberg, RawBuffer } from './index.js';
+
+const api = await Barretenberg.new(/* num_threads */ { threads: 1 });
 const input = Buffer.from('hello world!');
 const result = await api.blake2s(input);
 await api.destroy();
 ```
 
-All methods are asynchronous. If no threads are specified, will default to number of cores with a maximum of 16.
+All methods are asynchronous. If no threads are specified, will default to number of cores with a maximum of 32.
 If `1` is specified, fallback to non multi-threaded wasm that doesn't need shared memory.
 
-You can also create a synchronous version of the api that also has no multi-threading. This is only useful in the
-browser if you don't call any multi-threaded functions. It's probably best to just always use async version of the api
-unless you're really trying to avoid the small overhead of worker communication.
+See `src/main.ts` for larger example of how to use.
+
+### Browser Context
+
+It's recommended to use a dynamic import. This allows the developer to pick the time at which the package (several MB
+in size) is loaded and keeps page load times responsive.
 
 ```typescript
-const api = await newBarretenbergApiSync();
-// Use.
-const input = Buffer.from('hello world!');
-const result = api.blake2s(input);
-await api.destroy();
+const { Barretenberg, RawBuffer, Crs } = await import('@aztec/bb.js');
+```
+
+### Multithreading in browser
+
+Multithreading in bb.js requires [`SharedArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) to be enabled. It is only enabled in browsers if COOP and COEP headers are set by the server. Read more [here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer#security_requirements).
+
+You can configure your server to set these headers for pages that perform proof generation. See [this example project](https://github.com/saleel/gitclaim/blob/main/app/next.config.mjs#L48-L67) that implements multi-threaded browser proving, which contains the below Next.js config:
+
+```typescript
+{
+  ...
+  async headers() {
+    return [
+      {
+        source: '/:path*',
+        headers: [
+          { key: 'Cross-Origin-Embedder-Policy', value: 'require-corp' },
+          { key: 'Cross-Origin-Opener-Policy', value: 'same-origin' },
+        ],
+      },
+    ];
+  },
+}
 ```
 
-See `src/main.ts` for one example of how to use.
+Note that adding COOP and COEP headers will disable loading of external scripts, which might be required by your application.
+
+You can enable these headers for specific pages that perform proof generation, but this may be challenging, especially in single-page applications. One workaround is to move the proof generation to a separate page, load it in an invisible iframe within your main application, and then use `postMessage` to communicate between the pages for generating proofs.
 
 ## Development
 
 Create a symlink to the root script `bb.js-dev` in your path. You can now run the current state of the code from
 anywhere in your filesystem with no `yarn build` required.
 
-If you change the C++ code run `yarn build:wasm`.
+If you change the C++ code run `yarn build:wasm` to rebuild the webassembly.
 
 To run the tests run `yarn test`.
 
-To run a continuous "stress test" run `yarn simple_test` to do 10 full pk/proof/vk iterations.
+To run a continuous "stress test" run `yarn simple_test` to do 10 full pk/proof/vk iterations. This is useful for
+inspecting memory growth as we continuously use the library.
+
+## Debugging
+
+Got an unhelpful stack trace in wasm? Run:
+
+```
+NO_STRIP=1 ./script/build_wasm.sh
+```
 
-To run the same test in the browser run `yarn serve`, navigate to appropriate URL and open the console.
+This will drop unstripped wasms into the dest folder. Run your test again to get a trace.

package/package.json

@@ -1,79 +1,94 @@
 {
   "name": "@aztec/bb.js",
-  "version": "0.0.1-alpha.6",
+  "packageManager": "yarn@4.5.2",
+  "version": "0.0.1-fake-ceab37513c",
+  "homepage": "https://github.com/AztecProtocol/aztec-packages/tree/master/barretenberg/ts",
+  "license": "MIT",
   "type": "module",
-  "typedoc": {
-    "entryPoint": "./src/index.ts",
-    "displayName": "bb.js",
-    "tsconfig": "./tsconfig.json"
+  "types": "./dest/node/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dest/node-cjs/index.js",
+      "browser": "./dest/browser/index.js",
+      "default": "./dest/node/index.js"
+    }
   },
-  "bin": "./dest/main.js",
+  "bin": "dest/node/main.js",
   "files": [
     "src/",
     "dest/",
+    "cjs-entry/",
     "README.md"
   ],
   "scripts": {
-    "clean": "rm -rf ./dest .tsbuildinfo",
-    "build": "yarn clean && yarn build:wasm && tsc -b && webpack && chmod +x ./dest/main.js",
-    "build:dev": "tsc -b --watch",
-    "build:wasm": "cd ../cpp && cmake --preset wasm-threads && cmake --build --preset wasm-threads && cmake --preset wasm && cmake --build --preset wasm",
+    "clean": "rm -rf ./dest .tsbuildinfo .tsbuildinfo.cjs ./src/cbind/generated",
+    "build": "yarn clean && yarn generate && yarn build:wasm && yarn build:esm && yarn build:cjs && yarn build:browser",
+    "build:wasm": "./scripts/build_wasm.sh",
+    "build:esm": "tsc -b tsconfig.esm.json && chmod +x ./dest/node/main.js",
+    "build:cjs": "tsc -b tsconfig.cjs.json && ./scripts/cjs_postprocess.sh",
+    "build:browser": "tsc -b tsconfig.browser.json && ./scripts/browser_postprocess.sh",
     "build:bindings": "cd .. && ./scripts/bindgen.sh",
-    "serve": "webpack serve",
+    "generate": "NODE_OPTIONS='--loader ts-node/esm' NODE_NO_WARNINGS=1 ts-node src/cbind/generate.ts",
     "formatting": "prettier --check ./src && eslint --max-warnings 0 ./src",
     "formatting:fix": "prettier -w ./src",
     "test": "NODE_OPTIONS='--loader ts-node/esm' NODE_NO_WARNINGS=1 node --experimental-vm-modules $(yarn bin jest) --no-cache --passWithNoTests",
-    "test-debug": "NODE_OPTIONS='--loader ts-node/esm' NODE_NO_WARNINGS=1 node --inspect-brk=0.0.0.0 --experimental-vm-modules $(yarn bin jest) --no-cache --passWithNoTests --runInBand",
-    "simple_test": "NODE_OPTIONS='--loader ts-node/esm' NODE_NO_WARNINGS=1 node ./src/examples/simple.rawtest.ts",
-    "prepack": "yarn build",
-    "deploy": "npm publish --tag alpha --access public"
+    "test:debug": "NODE_NO_WARNINGS=1 node --inspect-brk=0.0.0.0 --experimental-vm-modules ./node_modules/.bin/jest --no-cache --passWithNoTests --runInBand",
+    "simple_test": "NODE_NO_WARNINGS=1 node ./src/examples/simple.rawtest.ts",
+    "deploy": "npm publish --access public"
   },
   "jest": {
     "preset": "ts-jest/presets/default-esm",
     "transform": {
-      "./src/.*\\.ts": [
-        "ts-jest",
+      "^.+\\.tsx?$": [
+        "@swc/jest",
         {
-          "useESM": true
+          "jsc": {
+            "parser": {
+              "syntax": "typescript",
+              "decorators": true
+            },
+            "transform": {
+              "decoratorVersion": "2022-03"
+            }
+          }
         }
       ]
     },
     "moduleNameMapper": {
       "^(\\.{1,2}/.*)\\.js$": "$1"
     },
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ],
     "testRegex": "./src/.*\\.test\\.ts$",
     "rootDir": "./src"
   },
   "dependencies": {
     "comlink": "^4.4.1",
-    "commander": "^10.0.1",
-    "debug": "^4.3.4",
-    "ts-node": "^10.9.1",
+    "commander": "^12.1.0",
+    "idb-keyval": "^6.2.1",
+    "msgpackr": "^1.11.2",
+    "pako": "^2.1.0",
+    "pino": "^9.5.0",
     "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "@jest/globals": "^29.4.3",
-    "@types/debug": "^4.1.7",
+    "@jest/globals": "^30.0.0",
+    "@swc/core": "^1.10.1",
+    "@swc/jest": "^0.2.37",
     "@types/detect-node": "^2.0.0",
-    "@types/jest": "^29.4.0",
-    "@types/node": "^18.7.23",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.15.17",
+    "@types/pako": "^2.0.3",
     "@types/source-map-support": "^0.5.6",
-    "@typescript-eslint/eslint-plugin": "^5.54.1",
-    "@typescript-eslint/parser": "^5.54.1",
-    "buffer": "^6.0.3",
-    "copy-webpack-plugin": "^11.0.0",
-    "eslint": "^8.35.0",
-    "eslint-config-prettier": "^8.8.0",
-    "html-webpack-plugin": "^5.5.1",
-    "idb-keyval": "^6.2.1",
-    "jest": "^29.5.0",
-    "prettier": "^2.8.4",
-    "resolve-typescript-plugin": "^2.0.1",
-    "ts-jest": "^29.1.0",
+    "eslint": "^9.26.0",
+    "eslint-config-prettier": "^10.1.5",
+    "jest": "^30.0.0",
+    "prettier": "^3.5.3",
+    "ts-jest": "^29.4.0",
     "ts-loader": "^9.4.2",
-    "typescript": "^5.0.4",
-    "webpack": "^5.82.1",
-    "webpack-cli": "^5.1.1",
-    "webpack-dev-server": "^4.15.0"
+    "ts-node": "^10.9.1",
+    "typescript": "^5.3.3",
+    "typescript-eslint": "^8.32.1"
   }
 }

package/src/barretenberg/__snapshots__/pedersen.test.ts.snap

@@ -0,0 +1,156 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`pedersen sync pedersenCommit 1`] = `
+Point {
+  "x": Fr {
+    "value": Uint8Array [
+      40,
+      159,
+      125,
+      144,
+      234,
+      153,
+      219,
+      166,
+      76,
+      75,
+      47,
+      51,
+      253,
+      27,
+      9,
+      101,
+      2,
+      145,
+      223,
+      38,
+      43,
+      114,
+      5,
+      21,
+      90,
+      97,
+      2,
+      6,
+      219,
+      97,
+      109,
+      152,
+    ],
+  },
+  "y": Fr {
+    "value": Uint8Array [
+      5,
+      175,
+      199,
+      200,
+      35,
+      67,
+      88,
+      76,
+      19,
+      203,
+      45,
+      50,
+      137,
+      153,
+      67,
+      200,
+      57,
+      87,
+      22,
+      209,
+      141,
+      173,
+      205,
+      189,
+      23,
+      215,
+      206,
+      3,
+      174,
+      112,
+      128,
+      11,
+    ],
+  },
+}
+`;
+
+exports[`pedersen sync pedersenHash 1`] = `
+Fr {
+  "value": Uint8Array [
+    4,
+    194,
+    53,
+    42,
+    6,
+    13,
+    74,
+    193,
+    205,
+    251,
+    96,
+    62,
+    188,
+    67,
+    39,
+    181,
+    118,
+    69,
+    151,
+    35,
+    22,
+    20,
+    246,
+    29,
+    36,
+    91,
+    243,
+    87,
+    114,
+    192,
+    134,
+    150,
+  ],
+}
+`;
+
+exports[`pedersen sync pedersenHashBuffer 1`] = `
+Fr {
+  "value": Uint8Array [
+    43,
+    213,
+    196,
+    82,
+    160,
+    201,
+    113,
+    98,
+    41,
+    79,
+    201,
+    223,
+    208,
+    241,
+    224,
+    157,
+    14,
+    9,
+    201,
+    95,
+    165,
+    237,
+    63,
+    241,
+    73,
+    251,
+    222,
+    243,
+    102,
+    203,
+    81,
+    249,
+  ],
+}
+`;

package/src/barretenberg/__snapshots__/poseidon.test.ts.snap

@@ -0,0 +1,40 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`poseidon sync poseidonHash 1`] = `
+Fr {
+  "value": Uint8Array [
+    43,
+    202,
+    235,
+    109,
+    88,
+    187,
+    56,
+    186,
+    247,
+    83,
+    213,
+    140,
+    60,
+    150,
+    97,
+    143,
+    234,
+    130,
+    22,
+    51,
+    69,
+    41,
+    94,
+    180,
+    14,
+    136,
+    52,
+    78,
+    235,
+    12,
+    226,
+    161,
+  ],
+}
+`;