feat: Compare bincode to CBOR, FlexBuffers and Protobuf - implement best

.github/workflows/publish-nargo.yml

@@ -54,6 +54,8 @@ jobs:
           cargo build --package nargo_cli --release --target ${{ matrix.target }} --no-default-features --features "${{ inputs.features }}"
           cargo build --package noir_profiler --release --target ${{ matrix.target }} --no-default-features --features "${{ inputs.features }}"
           cargo build --package noir_inspector --release --target ${{ matrix.target }} --no-default-features --features "${{ inputs.features }}"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Package artifacts
         run: |
@@ -237,5 +239,3 @@ jobs:
           make_latest: false
           overwrite: true
           tag: ${{ format('{0}-{1}', 'nightly', steps.date.outputs.date) }}
-
-

.github/workflows/reports.yml

@@ -42,6 +42,8 @@ jobs:
 
       - name: Build Nargo
         run: cargo build --package nargo_cli --release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Package artifacts
         run: |

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

@@ -64,6 +64,8 @@ jobs:
 
       - name: Build Nargo
         run: cargo build --package nargo_cli --release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Package artifacts
         run: |

Cargo.toml

@@ -37,6 +37,7 @@ members = [
     "acvm-repo/bn254_blackbox_solver",
     # Utility crates
     "utils/iter-extended",
+    "utils/protobuf",
 ]
 default-members = [
     "tooling/nargo_cli",
@@ -94,6 +95,7 @@ noirc_abi = { path = "tooling/noirc_abi" }
 noirc_artifacts = { path = "tooling/noirc_artifacts" }
 noirc_artifacts_info = { path = "tooling/noirc_artifacts_info" }
 noir_artifact_cli = { path = "tooling/artifact_cli" }
+noir_protobuf = { path = "utils/protobuf" }
 
 # Arkworks
 ark-bn254 = { version = "^0.5.0", default-features = false, features = [
@@ -137,6 +139,11 @@ criterion = "0.5.0"
 # https://github.com/tikv/pprof-rs/pull/172
 pprof = { version = "0.14", features = ["flamegraph", "criterion"] }
 
+# Protobuf
+prost = "0.13"
+prost-build = "0.13"
+protoc-prebuilt = "0.3"
+
 cfg-if = "1.0.0"
 dirs = "4"
 serde = { version = "1.0.136", features = ["derive"] }

acvm-repo/acir/Cargo.toml

@@ -18,26 +18,42 @@ workspace = true
 [dependencies]
 acir_field.workspace = true
 brillig.workspace = true
+noir_protobuf.workspace = true
+
+color-eyre.workspace = true
 serde.workspace = true
 thiserror.workspace = true
 flate2.workspace = true
 bincode.workspace = true
 base64.workspace = true
+prost.workspace = true
 serde-big-array = "0.5.1"
 strum = { workspace = true }
 strum_macros = { workspace = true }
 
+proptest = { workspace = true, optional = true }
+proptest-derive = { workspace = true, optional = true }
+
+[build-dependencies]
+prost-build.workspace = true
+protoc-prebuilt.workspace = true
+
 [dev-dependencies]
 serde_json = "1.0"
 serde-reflection = "0.3.6"
 serde-generate = "0.25.1"
 fxhash.workspace = true
 criterion.workspace = true
 pprof.workspace = true
+num-bigint.workspace = true
+
+acir = { path = ".", features = ["arb"] } # Self to turn on `arb`.
 
 [features]
+default = []
 bn254 = ["acir_field/bn254"]
 bls12_381 = ["acir_field/bls12_381"]
+arb = ["proptest", "proptest-derive", "brillig/arb"]
 
 [[bench]]
 name = "serialization"

acvm-repo/acir/build.rs

@@ -0,0 +1,24 @@
+use std::path::Path;
+
+fn main() {
+    let (protoc_bin, include_dir) =
+        protoc_prebuilt::init("29.3").expect("failed to initialize protoc");
+
+    unsafe {
+        std::env::set_var("PROTOC", protoc_bin);
+    }
+
+    prost_build::compile_protos(
+        &[
+            // DTOs for a `Program`, which work with the types in `acir.cpp`
+            "./src/proto/program.proto",
+            // DTOs for the `WitnessStack`, which work with the types in `witness.cpp`
+            "./src/proto/acir/witness.proto",
+            // A pared down DTO for `Program`, so Barretenberg can ignore the Brillig part.
+            // This is only included to make sure it compiles.
+            "./src/proto/acir/program.proto",
+        ],
+        &[Path::new("./src/proto"), include_dir.as_path()],
+    )
+    .expect("failed to compile .proto schemas");
+}

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

@@ -6,6 +6,7 @@ use serde::{Deserialize, Serialize};
 /// Inputs for the Brillig VM. These are the initial inputs
 /// that the Brillig VM will use to start.
 #[derive(Clone, PartialEq, Eq, Serialize, Deserialize, Debug, Hash)]
+#[cfg_attr(feature = "arb", derive(proptest_derive::Arbitrary))]
 pub enum BrilligInputs<F> {
     Single(Expression<F>),
     Array(Vec<Expression<F>>),
@@ -15,6 +16,7 @@ pub enum BrilligInputs<F> {
 /// Outputs for the Brillig VM. Once the VM has completed
 /// execution, this will be the object that is returned.
 #[derive(Clone, PartialEq, Eq, Serialize, Deserialize, Debug, Hash)]
+#[cfg_attr(feature = "arb", derive(proptest_derive::Arbitrary))]
 pub enum BrilligOutputs {
     Simple(Witness),
     Array(Vec<Witness>),
@@ -24,6 +26,7 @@ pub enum BrilligOutputs {
 /// a full Brillig function to be executed by the Brillig VM.
 /// This is stored separately on a program and accessed through a [BrilligPointer].
 #[derive(Clone, PartialEq, Eq, Serialize, Deserialize, Default, Debug, Hash)]
+#[cfg_attr(feature = "arb", derive(proptest_derive::Arbitrary))]
 pub struct BrilligBytecode<F> {
     pub bytecode: Vec<BrilligOpcode<F>>,
 }
@@ -32,6 +35,7 @@ pub struct BrilligBytecode<F> {
 #[derive(
     Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Hash, Copy, Default, PartialOrd, Ord,
 )]
+#[cfg_attr(feature = "arb", derive(proptest_derive::Arbitrary))]
 #[serde(transparent)]
 pub struct BrilligFunctionId(pub u32);