chore!: Separate barretenberg solver from generic blackbox solver code (

#554) Co-authored-by: TomAFrench <tom@tomfren.ch>
noir-lang · Sep 19, 2023 · a4b9772 · a4b9772
1 parent e4ba249
commit a4b9772
Show file tree

Hide file tree

Showing 30 changed files with 115 additions and 78 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -47,6 +47,12 @@ jobs:
         env:
           CARGO_REGISTRY_TOKEN: ${{ secrets.ACVM_CRATES_IO_TOKEN }}
 
+      - name: Publish barretenberg_blackbox_solver
+        run: |
+          cargo publish --package barretenberg_blackbox_solver
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.ACVM_CRATES_IO_TOKEN }}
+
       - name: Publish acvm_stdlib
         run: |
           cargo publish --package acvm_stdlib

diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -7,5 +7,6 @@
     "stdlib": "0.26.1",
     "brillig": "0.26.1",
     "brillig_vm": "0.26.1",
-    "blackbox_solver": "0.26.1"
+    "blackbox_solver": "0.26.1",
+    "barretenberg_blackbox_solver": "0.26.1"
 }
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [workspace]
 
-members = ["acir_field", "acir", "acvm", "acvm_js", "stdlib", "brillig", "brillig_vm", "blackbox_solver"]
+members = ["acir_field", "acir", "acvm", "acvm_js", "stdlib", "brillig", "brillig_vm", "blackbox_solver", "barretenberg_blackbox_solver"]
 resolver = "2"
 
 [workspace.package]
@@ -15,10 +15,12 @@ acir = { version = "0.26.1", path = "acir", default-features = false }
 acir_field = { version = "0.26.1", path = "acir_field", default-features = false }
 stdlib = { package = "acvm_stdlib", version = "0.26.1", path = "stdlib", default-features = false }
 brillig = { version = "0.26.1", path = "brillig", default-features = false }
-blackbox_solver = { package = "acvm_blackbox_solver", version = "0.26.1", path = "blackbox_solver", default-features = false }
+acvm_blackbox_solver = { version = "0.26.1", path = "blackbox_solver", default-features = false }
+barretenberg_blackbox_solver = { version = "0.26.1", path = "barretenberg_blackbox_solver", default-features = false }
 
 bincode = "1.3.3"
 
+hex = "0.4.2"
 num-bigint = "0.4"
 num-traits = "0.2"
 

diff --git a/acir_field/Cargo.toml b/acir_field/Cargo.toml
@@ -11,7 +11,7 @@ repository.workspace = true
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-hex = "0.4.2"
+hex.workspace = true
 num-bigint.workspace = true
 serde.workspace = true
 

diff --git a/acvm/Cargo.toml b/acvm/Cargo.toml
@@ -18,7 +18,7 @@ thiserror.workspace = true
 acir.workspace = true
 stdlib.workspace = true
 brillig_vm = { version = "0.26.1", path = "../brillig_vm", default-features = false }
-blackbox_solver.workspace = true
+acvm_blackbox_solver.workspace = true
 
 indexmap = "1.7.0"
 
@@ -28,13 +28,13 @@ bn254 = [
     "acir/bn254",
     "stdlib/bn254",
     "brillig_vm/bn254",
-    "blackbox_solver/bn254",
+    "acvm_blackbox_solver/bn254",
 ]
 bls12_381 = [
     "acir/bls12_381",
     "stdlib/bls12_381",
     "brillig_vm/bls12_381",
-    "blackbox_solver/bls12_381",
+    "acvm_blackbox_solver/bls12_381",
 ]
 testing = ["stdlib/testing", "unstable-fallbacks"]
 unstable-fallbacks = []

diff --git a/acvm/src/lib.rs b/acvm/src/lib.rs
@@ -4,7 +4,7 @@
 pub mod compiler;
 pub mod pwg;
 
-pub use blackbox_solver::{BlackBoxFunctionSolver, BlackBoxResolutionError};
+pub use acvm_blackbox_solver::{BlackBoxFunctionSolver, BlackBoxResolutionError};
 use core::fmt::Debug;
 use pwg::OpcodeResolutionError;
 
@@ -14,7 +14,7 @@ pub use acir::FieldElement;
 // re-export brillig vm
 pub use brillig_vm;
 // re-export blackbox solver
-pub use blackbox_solver;
+pub use acvm_blackbox_solver as blackbox_solver;
 
 /// Supported NP complete languages
 /// This might need to be in ACIR instead

diff --git a/acvm/src/pwg/blackbox/hash.rs b/acvm/src/pwg/blackbox/hash.rs
@@ -3,7 +3,7 @@ use acir::{
     native_types::{Witness, WitnessMap},
     BlackBoxFunc, FieldElement,
 };
-use blackbox_solver::{hash_to_field_128_security, BlackBoxResolutionError};
+use acvm_blackbox_solver::{hash_to_field_128_security, BlackBoxResolutionError};
 
 use crate::pwg::{insert_value, witness_to_value};
 use crate::OpcodeResolutionError;

diff --git a/acvm/src/pwg/blackbox/mod.rs b/acvm/src/pwg/blackbox/mod.rs
@@ -3,7 +3,7 @@ use acir::{
     native_types::{Witness, WitnessMap},
     FieldElement,
 };
-use blackbox_solver::{blake2s, keccak256, sha256};
+use acvm_blackbox_solver::{blake2s, keccak256, sha256};
 
 use super::{insert_value, OpcodeNotSolvable, OpcodeResolutionError};
 use crate::BlackBoxFunctionSolver;

diff --git a/acvm/src/pwg/blackbox/signature/ecdsa.rs b/acvm/src/pwg/blackbox/signature/ecdsa.rs
@@ -3,7 +3,7 @@ use acir::{
     native_types::{Witness, WitnessMap},
     FieldElement,
 };
-use blackbox_solver::{ecdsa_secp256k1_verify, ecdsa_secp256r1_verify};
+use acvm_blackbox_solver::{ecdsa_secp256k1_verify, ecdsa_secp256r1_verify};
 
 use crate::{pwg::insert_value, OpcodeResolutionError};
 

diff --git a/acvm/src/pwg/brillig.rs b/acvm/src/pwg/brillig.rs
@@ -7,7 +7,7 @@ use acir::{
     native_types::WitnessMap,
     FieldElement,
 };
-use blackbox_solver::BlackBoxFunctionSolver;
+use acvm_blackbox_solver::BlackBoxFunctionSolver;
 use brillig_vm::{Registers, VMStatus, VM};
 
 use crate::{pwg::OpcodeNotSolvable, OpcodeResolutionError};
@@ -150,7 +150,7 @@ impl BrilligSolver {
     }
 }
 
-/// Encapsulates a request from a Brillig VM process that encounters a [foreign call opcode][acir::brillig_vm::Opcode::ForeignCall]  
+/// Encapsulates a request from a Brillig VM process that encounters a [foreign call opcode][acir::brillig_vm::Opcode::ForeignCall]
 /// where the result of the foreign call has not yet been provided.
 ///
 /// The caller must resolve this opcode externally based upon the information in the request.

diff --git a/acvm/src/pwg/mod.rs b/acvm/src/pwg/mod.rs
@@ -8,7 +8,7 @@ use acir::{
     native_types::{Expression, Witness, WitnessMap},
     BlackBoxFunc, FieldElement,
 };
-use blackbox_solver::BlackBoxResolutionError;
+use acvm_blackbox_solver::BlackBoxResolutionError;
 
 use self::{
     arithmetic::ArithmeticSolver, brillig::BrilligSolver, directives::solve_directives,

diff --git a/acvm/tests/solver.rs b/acvm/tests/solver.rs
@@ -15,7 +15,7 @@ use acvm::{
     pwg::{ACVMStatus, ErrorLocation, ForeignCallWaitInfo, OpcodeResolutionError, ACVM},
     BlackBoxFunctionSolver,
 };
-use blackbox_solver::BlackBoxResolutionError;
+use acvm_blackbox_solver::BlackBoxResolutionError;
 
 pub(crate) struct StubbedBackend;
 

diff --git a/acvm/tests/stdlib.rs b/acvm/tests/stdlib.rs
@@ -14,7 +14,7 @@ use acvm::{
     pwg::{ACVMStatus, ACVM},
     Language,
 };
-use blackbox_solver::{blake2s, hash_to_field_128_security, keccak256, sha256};
+use acvm_blackbox_solver::{blake2s, hash_to_field_128_security, keccak256, sha256};
 use paste::paste;
 use proptest::prelude::*;
 use std::collections::{BTreeMap, BTreeSet};

diff --git a/acvm_js/Cargo.toml b/acvm_js/Cargo.toml
@@ -18,6 +18,7 @@ cfg-if = "1.0.0"
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 acvm = { version = "0.26.1", path = "../acvm", default-features = false }
+barretenberg_blackbox_solver = { version = "0.26.1", path = "../barretenberg_blackbox_solver", default-features = false }
 wasm-bindgen = { version = "0.2.87", features = ["serde-serialize"] }
 wasm-bindgen-futures = "0.4.36"
 serde = { version = "1.0.136", features = ["derive"] }
@@ -37,6 +38,6 @@ wasm-bindgen-test = "0.3.36"
 
 [features]
 default = ["bn254"]
-bn254 = ["acvm/bn254"]
-bls12_381 = ["acvm/bls12_381"]
+bn254 = ["acvm/bn254", "barretenberg_blackbox_solver/bn254"]
+bls12_381 = ["acvm/bls12_381", "barretenberg_blackbox_solver/bls12_381"]
 
diff --git a/acvm_js/src/execute.rs b/acvm_js/src/execute.rs
@@ -1,9 +1,9 @@
-#[allow(deprecated)]
 use acvm::{
     acir::circuit::{Circuit, OpcodeLocation},
-    blackbox_solver::BarretenbergSolver,
     pwg::{ACVMStatus, ErrorLocation, OpcodeResolutionError, ACVM},
 };
+#[allow(deprecated)]
+use barretenberg_blackbox_solver::BarretenbergSolver;
 
 use js_sys::Error;
 use wasm_bindgen::prelude::wasm_bindgen;

diff --git a/barretenberg_blackbox_solver/Cargo.toml b/barretenberg_blackbox_solver/Cargo.toml
@@ -0,0 +1,51 @@
+[package]
+name = "barretenberg_blackbox_solver"
+description = "A wrapper around a barretenberg WASM binary to execute black box functions for which there is no rust implementation"
+version = "0.26.1"
+authors.workspace = true
+edition.workspace = true
+license.workspace = true
+rust-version.workspace = true
+repository.workspace = true
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+acir.workspace = true
+acvm_blackbox_solver.workspace = true
+thiserror.workspace = true
+hex.workspace = true
+num-bigint.workspace = true
+
+rust-embed = { version = "6.6.0", features = [
+    "debug-embed",
+    "interpolate-folder-path",
+    "include-exclude",
+] }
+
+[target.'cfg(target_arch = "wasm32")'.dependencies]
+wasmer = { version = "3.3", default-features = false, features = [
+    "js-default",
+] }
+
+getrandom = { version = "0.2", features = ["js"] }
+wasm-bindgen-futures = "0.4.36"
+js-sys = "0.3.62"
+
+[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
+getrandom = "0.2"
+wasmer = "3.3"
+
+[build-dependencies]
+pkg-config = "0.3"
+tar = "~0.4.15"
+flate2 = "~1.0.1"
+reqwest = { version = "0.11.16", default-features = false, features = [
+    "rustls-tls",
+    "blocking",
+] }
+
+[features]
+default = ["bn254"]
+bn254 = ["acir/bn254"]
+bls12_381 = ["acir/bls12_381"]
diff --git a/blackbox_solver/build.rs → barretenberg_blackbox_solver/build.rs b/blackbox_solver/build.rs → barretenberg_blackbox_solver/build.rs
diff --git a/blackbox_solver/src/barretenberg/mod.rs → barretenberg_blackbox_solver/src/lib.rs b/blackbox_solver/src/barretenberg/mod.rs → barretenberg_blackbox_solver/src/lib.rs
@@ -1,6 +1,5 @@
 use acir::{BlackBoxFunc, FieldElement};
-
-use crate::{BlackBoxFunctionSolver, BlackBoxResolutionError};
+use acvm_blackbox_solver::{BlackBoxFunctionSolver, BlackBoxResolutionError};
 
 mod wasm;
 

diff --git a/...retenberg/wasm/barretenberg_structures.rs → ...olver/src/wasm/barretenberg_structures.rs b/...retenberg/wasm/barretenberg_structures.rs → ...olver/src/wasm/barretenberg_structures.rs
diff --git a/blackbox_solver/src/barretenberg/wasm/mod.rs → barretenberg_blackbox_solver/src/wasm/mod.rs b/blackbox_solver/src/barretenberg/wasm/mod.rs → barretenberg_blackbox_solver/src/wasm/mod.rs
diff --git a/..._solver/src/barretenberg/wasm/pedersen.rs → ...berg_blackbox_solver/src/wasm/pedersen.rs b/..._solver/src/barretenberg/wasm/pedersen.rs → ...berg_blackbox_solver/src/wasm/pedersen.rs
diff --git a/...olver/src/barretenberg/wasm/scalar_mul.rs → ...rg_blackbox_solver/src/wasm/scalar_mul.rs b/...olver/src/barretenberg/wasm/scalar_mul.rs → ...rg_blackbox_solver/src/wasm/scalar_mul.rs
@@ -1,7 +1,7 @@
 use acir::FieldElement;
 use num_bigint::BigUint;
 
-use crate::barretenberg::wasm::FeatureError;
+use crate::wasm::FeatureError;
 
 use super::{Barretenberg, Error, FIELD_BYTES};
 

diff --git a/...x_solver/src/barretenberg/wasm/schnorr.rs → ...nberg_blackbox_solver/src/wasm/schnorr.rs b/...x_solver/src/barretenberg/wasm/schnorr.rs → ...nberg_blackbox_solver/src/wasm/schnorr.rs
diff --git a/blackbox_solver/Cargo.toml b/blackbox_solver/Cargo.toml
@@ -31,37 +31,6 @@ p256 = { version = "0.11.0", features = [
     "digest",
     "arithmetic",
 ] }
-hex = "0.4.2"
-num-bigint.workspace = true
-
-# Barretenberg WASM dependencies
-rust-embed = { version = "6.6.0", features = [
-    "debug-embed",
-    "interpolate-folder-path",
-    "include-exclude",
-] }
-[target.'cfg(target_arch = "wasm32")'.dependencies]
-wasmer = { version = "3.3", default-features = false, features = [
-    "js-default",
-] }
-getrandom = { version = "0.2", features = ["js"] }
-wasm-bindgen-futures = "0.4.36"
-js-sys = "0.3.62"
-
-
-[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
-getrandom = "0.2"
-wasmer = "3.3"
-
-
-[build-dependencies]
-pkg-config = "0.3"
-tar = "~0.4.15"
-flate2 = "~1.0.1"
-reqwest = { version = "0.11.16", default-features = false, features = [
-    "rustls-tls",
-    "blocking",
-] }
 
 [features]
 default = ["bn254"]

diff --git a/blackbox_solver/src/lib.rs b/blackbox_solver/src/lib.rs
@@ -12,11 +12,6 @@ use sha2::Sha256;
 use sha3::Keccak256;
 use thiserror::Error;
 
-mod barretenberg;
-
-#[allow(deprecated)]
-pub use barretenberg::BarretenbergSolver;
-
 #[derive(Clone, PartialEq, Eq, Debug, Error)]
 pub enum BlackBoxResolutionError {
     #[error("unsupported blackbox function: {0}")]
@@ -27,7 +22,7 @@ pub enum BlackBoxResolutionError {
 
 /// This component will generate outputs for Blackbox function calls where the underlying [`acir::BlackBoxFunc`]
 /// doesn't have a canonical Rust implementation.
-///o
+///
 /// Returns an [`BlackBoxResolutionError`] if the backend does not support the given [`acir::BlackBoxFunc`].
 pub trait BlackBoxFunctionSolver {
     fn schnorr_verify(