chore: rename acvm-simulator to acvm_js (#59)

.github/workflows/release.yml

@@ -55,16 +55,16 @@ jobs:
           git commit -m 'chore: Update lockfile'
           git push
 
-  dispatch-acvm-simulator-wasm:
-    name: Dispatch to acvm-simulator-wasm
+  dispatch-acvm-js-wasm:
+    name: Dispatch to acvm-js-wasm
     needs: [release-please]
     if: ${{ needs.release-please.outputs.tag-name }}
     runs-on: ubuntu-latest
     steps:
-      - name: Dispatch to acvm-simulator-wasm
+      - name: Dispatch to acvm-js-wasm
         uses: benc-uk/workflow-dispatch@v1
         with:
           workflow: update.yml
-          repo: noir-lang/acvm-simulator-wasm
+          repo: noir-lang/acvm-js-wasm
           token: ${{ secrets.ACVM_SIMULATOR_RELEASES_TOKEN }}
-          inputs: '{ "acvm-simulator-ref": "${{ needs.release-please.outputs.tag-name }}" }'
+          inputs: '{ "acvm-js-ref": "${{ needs.release-please.outputs.tag-name }}" }'

.github/workflows/test.yml

@@ -8,7 +8,7 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  build-acvm-simulator:
+  build-acvm-js:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
@@ -24,7 +24,7 @@ jobs:
           name: barretenberg
           authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"
 
-      - name: Build acvm-simulator
+      - name: Build acvm-js
         run: |
           nix build .#
 
@@ -34,12 +34,12 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-artifact@v3
         with:
-          name: acvm-simulator
+          name: acvm-js
           path: ${{ env.UPLOAD_PATH }}
           retention-days: 3
 
   test-node:
-    needs: [build-acvm-simulator]
+    needs: [build-acvm-js]
     name: Node.js Tests
     runs-on: ubuntu-latest
 
@@ -50,7 +50,7 @@ jobs:
       - name: Download artifact
         uses: actions/download-artifact@v3
         with:
-          name: acvm-simulator
+          name: acvm-js
           path: ./result
 
       - name: Set up test environment
@@ -60,7 +60,7 @@ jobs:
         run: yarn test
 
   test-browser:
-    needs: [build-acvm-simulator]
+    needs: [build-acvm-js]
     name: Browser Tests
     runs-on: ubuntu-latest
 
@@ -71,7 +71,7 @@ jobs:
       - name: Download artifact
         uses: actions/download-artifact@v3
         with:
-          name: acvm-simulator
+          name: acvm-js
           path: ./result
 
       - name: Set up test environment

Cargo.toml

@@ -1,10 +1,10 @@
 [package]
-name = "acvm_simulator"
+name = "acvm_js"
 description = "Typescript wrapper around the ACVM allowing execution of ACIR code"
 version = "0.0.0" # x-release-please-version
 authors = ["The Noir Team <[email protected]>"]
 license = "MIT OR Apache-2.0"
-repository = "https://github.com/noir-lang/acvm-simulator"
+repository = "https://github.com/noir-lang/acvm_js"
 edition = "2021"
 rust-version = "1.66"
 

README.md

@@ -1,6 +1,6 @@
-# ACVM Simulator
+# acvm_js
 
-The ACVM Simulator enables users to execute an ACIR program, i.e. generating an initial witness from a set of inputs and calculating a partial witness. This partial witness can then be used to create a proof of execution using an ACVM backend.
+The `acvm_js` package enables users to execute an ACIR program, i.e. generating an initial witness from a set of inputs and calculating a partial witness. This partial witness can then be used to create a proof of execution using an ACVM backend.
 
 ## Dependencies
 

flake.nix

@@ -1,5 +1,5 @@
 {
-  description = "ACVM Simulator";
+  description = "Javascript bindings for the ACVM";
 
   inputs = {
     nixpkgs = {
@@ -95,7 +95,7 @@
       GIT_DIRTY = if (self ? rev) then "false" else "true";
 
       commonArgs = {
-        pname = "acvm_simulator";
+        pname = "acvm_js";
         version = "0.0.0"; # x-release-please-version
 
         src = pkgs.lib.cleanSourceWith {

package.json

@@ -1,18 +1,18 @@
 {
-  "name": "acvm-simulator",
+  "name": "acvm_js",
   "version": "0.0.0",
   "private": true,
   "repository": {
     "type": "git",
-    "url": "https://github.com/noir-lang/acvm-simulator.git"
+    "url": "https://github.com/noir-lang/acvm_js.git"
   },
   "collaborators": [
     "The Noir Team <[email protected]>"
   ],
   "license": "MIT",
-  "main": "./nodejs/acvm_simulator.js",
-  "types": "./web/acvm_simulator.d.ts",
-  "module": "./web/acvm_simulator.js",
+  "main": "./nodejs/acvm_js.js",
+  "types": "./web/acvm_js.d.ts",
+  "module": "./web/acvm_js.js",
   "files": [
     "nodejs",
     "web",
@@ -40,4 +40,4 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.0.4"
   }
-}
+}

src/barretenberg/mod.rs

@@ -1,4 +1,4 @@
-//! ACVM simulator is independent of the proving backend against which the ACIR code is being proven.
+//! ACVM execution is independent of the proving backend against which the ACIR code is being proven.
 //! However there are currently a few opcodes for which there is currently no rust implementation so we must
 //! use the C++ implementations included in Aztec Lab's Barretenberg library.
 //!

test/browser/abi_encode.test.ts

@@ -1,13 +1,9 @@
 import { expect } from "@esm-bundle/chai";
-import initACVMSimulator, {
-  abiEncode,
-  abiDecode,
-  WitnessMap,
-} from "../../result/";
+import initACVM, { abiEncode, abiDecode, WitnessMap } from "../../result/";
 import { DecodedInputs } from "../types";
 
 beforeEach(async () => {
-  await initACVMSimulator();
+  await initACVM();
 });
 
 it("recovers original inputs when abi encoding and decoding", async () => {

test/browser/execute_circuit.test.ts

@@ -1,5 +1,5 @@
 import { expect } from "@esm-bundle/chai";
-import initACVMSimulator, {
+import initACVM, {
   abiEncode,
   abiDecode,
   executeCircuit,
@@ -8,7 +8,7 @@ import initACVMSimulator, {
 } from "../../result/";
 
 beforeEach(async () => {
-  await initACVMSimulator();
+  await initACVM();
 
   initLogLevel("INFO");
 });

test/browser/witness_conversion.test.ts

@@ -1,15 +1,12 @@
 import { expect } from "@esm-bundle/chai";
-import initACVMSimulator, {
-  compressWitness,
-  decompressWitness,
-} from "../../result/";
+import initACVM, { compressWitness, decompressWitness } from "../../result/";
 import {
   expectedCompressedWitnessMap,
   expectedWitnessMap,
 } from "../shared/witness_compression";
 
 beforeEach(async () => {
-  await initACVMSimulator();
+  await initACVM();
 });
 
 it("successfully compresses the witness", async () => {

yarn.lock

@@ -1258,9 +1258,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"acvm-simulator@workspace:.":
+"acvm_js@workspace:.":
   version: 0.0.0-use.local
-  resolution: "acvm-simulator@workspace:."
+  resolution: "acvm_js@workspace:."
   dependencies:
     "@esm-bundle/chai": ^4.3.4-fix.0
     "@typescript-eslint/eslint-plugin": ^5.59.5