feat(acir)!: Add predicate to call opcode (AztecProtocol/aztec-packag…

…es#5616)

Resolves this issue #4707.

We simply add a `predicate` onto the Call opcode and handle it how we do
other predicates such as for Brillig opcodes and memory ops. I also made
a general utility method for checking a predicate in the VM as it now
happens for three different opcodes.

---------

Co-authored-by: AztecBot <[email protected]>
Co-authored-by: ludamad <[email protected]>
Co-authored-by: sirasistant <[email protected]>
Co-authored-by: Tom French <[email protected]>

.aztec-sync-commit

@@ -1 +1 @@
-bb719200034e3bc6db09fb56538dadca4203abf4
+e8cec0a81da29a1b4df8bc6c70b04e37902f7609

.envrc

@@ -17,4 +17,4 @@ if [[ -z "${SKIP_NIX:-}" ]] && has nix; then
 		use nix
 	fi
 
-fi
+fi

.github/Cross.toml

@@ -2,8 +2,6 @@
 passthrough = [
     "HOME",
     "RUST_BACKTRACE",
-    "BARRETENBERG_BIN_DIR",
-    "BLNS_JSON_PATH"
 ]
 volumes = [
     "HOME",

.github/scripts/acvm_js-build.sh

@@ -2,4 +2,5 @@
 set -eu
 
 .github/scripts/wasm-bindgen-install.sh
+.github/scripts/wasm-opt-install.sh
 yarn workspace @noir-lang/acvm_js build

.github/scripts/noir-wasm-build.sh

@@ -2,5 +2,6 @@
 set -eu
 
 .github/scripts/wasm-pack-install.sh
+.github/scripts/wasm-opt-install.sh
 yarn workspace @noir-lang/types build
 yarn workspace @noir-lang/noir_wasm build

.github/scripts/noirc-abi-build.sh

@@ -2,4 +2,5 @@
 set -eu
 
 .github/scripts/wasm-bindgen-install.sh
+.github/scripts/wasm-opt-install.sh
 yarn workspace @noir-lang/noirc_abi build

.github/scripts/wasm-opt-install.sh

@@ -5,4 +5,4 @@ cd $(dirname "$0")
 
 ./cargo-binstall-install.sh
 
-cargo-binstall wasm-opt --version 0.116.0 -y
+cargo-binstall wasm-opt --version 0.116.0 -y --force

.github/workflows/test-js-packages.yml

@@ -66,17 +66,16 @@ jobs:
       - name: Install Yarn dependencies
         uses: ./.github/actions/setup
 
-      - name: Install wasm-opt
-        run: ./.github/scripts/wasm-opt-install.sh
-
       - name: Build noirc_abi
         run: ./.github/scripts/noirc-abi-build.sh
 
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:
           name: noirc_abi_wasm
-          path: ./tooling/noirc_abi_wasm/outputs/out/noirc_abi_wasm
+          path: | 
+            ./tooling/noirc_abi_wasm/nodejs
+            ./tooling/noirc_abi_wasm/web
           retention-days: 10
 
 
@@ -100,9 +99,6 @@ jobs:
       - name: Install Yarn dependencies
         uses: ./.github/actions/setup
 
-      - name: Install wasm-opt
-        run: ./.github/scripts/wasm-opt-install.sh
-
       - name: Build noir_js_types
         run: yarn workspace @noir-lang/types build
 
@@ -138,17 +134,16 @@ jobs:
       - name: Install Yarn dependencies
         uses: ./.github/actions/setup
 
-      - name: Install wasm-opt
-        run: ./.github/scripts/wasm-opt-install.sh
-
       - name: Build acvm_js
         run: ./.github/scripts/acvm_js-build.sh
 
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:
           name: acvm-js
-          path: ./acvm-repo/acvm_js/outputs/out/acvm_js
+          path: |
+            ./acvm-repo/acvm_js/nodejs
+            ./acvm-repo/acvm_js/web
           retention-days: 3
 
   test-acvm_js-node:

.gitignore

@@ -17,12 +17,6 @@ pkg/
 # Noir.js
 tooling/noir_js/lib
 
-# Nix stuff
-**/outputs
-result
-.envrc.local
-.direnv/
-
 # Nargo output
 *.proof
 *.acir

.vscode/extensions.json

@@ -4,7 +4,6 @@
 	// List of extensions which should be recommended for users of this workspace.
 	"recommendations": [
 		"mkhl.direnv",
-		"jnoortheen.nix-ide",
 		"rust-lang.rust-analyzer",
 		"redhat.vscode-yaml",
 		"esbenp.prettier-vscode",

.vscode/settings.json

@@ -2,17 +2,6 @@
     "direnv.restart.automatic": true,
     "redhat.telemetry.enabled": false,
     "yaml.recommendations.show": false,
-    "nix.serverPath": "nil",
-    "nix.enableLanguageServer": true,
-    "nix.serverSettings": {
-        "nil": {
-            "formatting": {
-                "command": [
-                    "nixpkgs-fmt"
-                ]
-            }
-        }
-    },
     "yaml.schemas": {
         "https://json.schemastore.org/github-workflow.json": "${workspaceRoot}/.github/workflows/*.yml"
     },

README.md

@@ -56,26 +56,6 @@ Concretely the following items are on the road map:
 
 This crate's minimum supported rustc version is 1.73.0.
 
-## Working on this project
-
-This project uses [Nix](https://nixos.org/) and [direnv](https://direnv.net/) to streamline the development experience. Please follow [our guidelines](https://noir-lang.org/docs/getting_started/installation/other_install_methods#option-3-compile-from-source) to setup your environment for working on the project.
-
-### Building against a different local/remote version of Barretenberg
-
-If you are working on this project and want a different version of Barretenberg (instead of the version this project is pinned against), you'll want to replace the lockfile version with your version. This can be done by running:
-
-```sh
-nix flake lock --override-input barretenberg /absolute/path/to/your/barretenberg
-```
-
-You can also point at a fork and/or branch on GitHub using:
-
-```sh
-nix flake lock --override-input barretenberg github:username/barretenberg/branch_name
-```
-
-__Note:__ You don't want to commit the updated lockfile, as it will fail in CI!
-
 ## License
 
 Noir is free and open source. It is distributed under a dual license. (MIT/APACHE)

acvm-repo/acir/codegen/acir.cpp

@@ -1074,6 +1074,7 @@ namespace Program {
             uint32_t id;
             std::vector<Program::Witness> inputs;
             std::vector<Program::Witness> outputs;
+            std::optional<Program::Expression> predicate;
 
             friend bool operator==(const Call&, const Call&);
             std::vector<uint8_t> bincodeSerialize() const;
@@ -6173,6 +6174,7 @@ namespace Program {
         if (!(lhs.id == rhs.id)) { return false; }
         if (!(lhs.inputs == rhs.inputs)) { return false; }
         if (!(lhs.outputs == rhs.outputs)) { return false; }
+        if (!(lhs.predicate == rhs.predicate)) { return false; }
         return true;
     }
 
@@ -6199,6 +6201,7 @@ void serde::Serializable<Program::Opcode::Call>::serialize(const Program::Opcode
     serde::Serializable<decltype(obj.id)>::serialize(obj.id, serializer);
     serde::Serializable<decltype(obj.inputs)>::serialize(obj.inputs, serializer);
     serde::Serializable<decltype(obj.outputs)>::serialize(obj.outputs, serializer);
+    serde::Serializable<decltype(obj.predicate)>::serialize(obj.predicate, serializer);
 }
 
 template <>
@@ -6208,6 +6211,7 @@ Program::Opcode::Call serde::Deserializable<Program::Opcode::Call>::deserialize(
     obj.id = serde::Deserializable<decltype(obj.id)>::deserialize(deserializer);
     obj.inputs = serde::Deserializable<decltype(obj.inputs)>::deserialize(deserializer);
     obj.outputs = serde::Deserializable<decltype(obj.outputs)>::deserialize(deserializer);
+    obj.predicate = serde::Deserializable<decltype(obj.predicate)>::deserialize(deserializer);
     return obj;
 }
 

acvm-repo/acir/src/circuit/mod.rs

@@ -216,25 +216,33 @@ impl std::fmt::Display for Circuit {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         writeln!(f, "current witness index : {}", self.current_witness_index)?;
 
-        let write_public_inputs = |f: &mut std::fmt::Formatter<'_>,
-                                   public_inputs: &PublicInputs|
-         -> Result<(), std::fmt::Error> {
-            write!(f, "[")?;
-            let public_input_indices = public_inputs.indices();
-            for (index, public_input) in public_input_indices.iter().enumerate() {
-                write!(f, "{public_input}")?;
-                if index != public_input_indices.len() - 1 {
-                    write!(f, ", ")?;
+        let write_witness_indices =
+            |f: &mut std::fmt::Formatter<'_>, indices: &[u32]| -> Result<(), std::fmt::Error> {
+                write!(f, "[")?;
+                for (index, witness_index) in indices.iter().enumerate() {
+                    write!(f, "{witness_index}")?;
+                    if index != indices.len() - 1 {
+                        write!(f, ", ")?;
+                    }
                 }
-            }
-            writeln!(f, "]")
-        };
+                writeln!(f, "]")
+            };
+
+        write!(f, "private parameters indices : ")?;
+        write_witness_indices(
+            f,
+            &self
+                .private_parameters
+                .iter()
+                .map(|witness| witness.witness_index())
+                .collect::<Vec<_>>(),
+        )?;
 
         write!(f, "public parameters indices : ")?;
-        write_public_inputs(f, &self.public_parameters)?;
+        write_witness_indices(f, &self.public_parameters.indices())?;
 
         write!(f, "return value indices : ")?;
-        write_public_inputs(f, &self.return_values)?;
+        write_witness_indices(f, &self.return_values.indices())?;
 
         for opcode in &self.opcodes {
             writeln!(f, "{opcode}")?;