feat(feature_branch): Private Kernel Circuit

circuits/cpp/src/aztec3/circuits/abis/packers.hpp

@@ -129,6 +129,7 @@ struct GeneratorIndexPacker {
         int SIGNED_TX_REQUEST = GeneratorIndex::SIGNED_TX_REQUEST;
         int GLOBAL_VARIABLES = GeneratorIndex::GLOBAL_VARIABLES;
         int PARTIAL_ADDRESS = GeneratorIndex::PARTIAL_ADDRESS;
+        int BLOCK_HASH = GeneratorIndex::BLOCK_HASH;
         int TX_REQUEST = GeneratorIndex::TX_REQUEST;
         int SIGNATURE_PAYLOAD = GeneratorIndex::SIGNATURE_PAYLOAD;
         int VK = GeneratorIndex::VK;
@@ -166,6 +167,7 @@ struct GeneratorIndexPacker {
                  SIGNED_TX_REQUEST,
                  GLOBAL_VARIABLES,
                  PARTIAL_ADDRESS,
+                 BLOCK_HASH,
                  TX_REQUEST,
                  SIGNATURE_PAYLOAD,
                  VK,

yarn-project/aztec-nr/aztec/src/constants_gen.nr

@@ -100,6 +100,7 @@ global GENERATOR_INDEX__PUBLIC_DATA_LEAF = 24;
 global GENERATOR_INDEX__SIGNED_TX_REQUEST = 25;
 global GENERATOR_INDEX__GLOBAL_VARIABLES = 26;
 global GENERATOR_INDEX__PARTIAL_ADDRESS = 27;
+global GENERATOR_INDEX__BLOCK_HASH = 28;
 global GENERATOR_INDEX__TX_REQUEST = 33;
 global GENERATOR_INDEX__SIGNATURE_PAYLOAD = 34;
 global GENERATOR_INDEX__VK = 41;

yarn-project/circuits.js/src/cbind/constants.gen.ts

@@ -102,6 +102,7 @@ export enum GeneratorIndex {
   SIGNED_TX_REQUEST = 25,
   GLOBAL_VARIABLES = 26,
   PARTIAL_ADDRESS = 27,
+  BLOCK_HASH = 28,
   TX_REQUEST = 33,
   SIGNATURE_PAYLOAD = 34,
   VK = 41,

yarn-project/circuits.js/src/structs/index.ts

@@ -35,3 +35,10 @@ export * from '@aztec/foundation/eth-address';
 export * from '@aztec/foundation/fields';
 export * from '@aztec/foundation/aztec-address';
 export { FunctionSelector } from '@aztec/foundation/abi';
+
+// TODO(Kev): This is only exported so that privateKernelInit in noir-private-kernel
+// does not need to manually initialize its instance.
+// This is not great as we are exporting from tests.
+// Its okay for now and before merging into master, we should
+// remove this line.
+export { makePrivateKernelInputsInit } from '../tests/factories.js';

yarn-project/noir-compiler/src/index.ts

@@ -11,6 +11,8 @@ export { generateNoirContractInterface } from './contract-interface-gen/noir.js'
 export { generateTypescriptContractInterface } from './contract-interface-gen/typescript.js';
 export { generateAztecAbi };
 
+export * from './noir_artifact.js';
+
 /**
  * Compile Aztec.nr contracts in project path using a nargo binary available in the shell.
  * @param projectPath - Path to project.

yarn-project/noir-compiler/src/noir_artifact.ts

@@ -4,7 +4,7 @@ import { ABIParameter, ABIType, DebugFileMap, DebugInfo } from '@aztec/foundatio
 type NoirFunctionType = 'Open' | 'Secret' | 'Unconstrained';
 
 /** The ABI of an Aztec.nr function. */
-interface NoirFunctionAbi {
+export interface NoirFunctionAbi {
   /** The parameters of the function. */
   parameters: ABIParameter[];
   /** The witness indices of the parameters. Indexed by parameter name. */
@@ -47,6 +47,22 @@ export interface NoirCompiledContract {
   functions: NoirFunctionEntry[];
 }
 
+/**
+ * The compilation result of an Aztec.nr contract.
+ */
+export interface NoirCompiledCircuit {
+  /** The hash of the circuit. */
+  hash: number;
+  /** Compilation backend. */
+  backend: string;
+  /**
+   * The ABI of the function.
+   */
+  abi: NoirFunctionAbi;
+  /** The bytecode of the circuit in base64. */
+  bytecode: string;
+}
+
 /**
  * The debug metadata of an Aztec.nr contract.
  */

yarn-project/noir-private-kernel/.eslintrc.cjs

@@ -0,0 +1 @@
+module.exports = require('@aztec/foundation/eslint');

yarn-project/noir-private-kernel/.gitignore

@@ -0,0 +1,3 @@
+proofs/
+Prover.toml
+Verifier.toml

yarn-project/noir-private-kernel/.prettierignore

@@ -0,0 +1,3 @@
+src/crates
+src/target
+src/types

yarn-project/noir-private-kernel/README.md

@@ -0,0 +1 @@
+# Noir Private Kernel

yarn-project/noir-private-kernel/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@aztec/noir-private-kernel",
+  "version": "0.1.0",
+  "type": "module",
+  "exports": {
+    ".": "./dest/index.js",
+    "./types": "./dest/types/index.js"
+  },
+  "scripts": {
+    "build": "yarn clean && tsc -b",
+    "build:dev": "tsc -b --watch",
+    "clean": "rm -rf ./dest .tsbuildinfo",
+    "formatting": "run -T prettier --check ./src && run -T eslint ./src",
+    "formatting:fix": "run -T prettier -w ./src",
+    "noir:build": "cd src && nargo compile",
+    "noir:types": "yarn ts-node --esm src/scripts/generate_ts_from_abi.ts",
+    "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules $(yarn bin jest) --passWithNoTests"
+  },
+  "inherits": [
+    "../package.common.json"
+  ],
+  "jest": {
+    "preset": "ts-jest/presets/default-esm",
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.m?js$": "$1"
+    },
+    "testRegex": "./src/.*\\.test\\.(js|mjs|ts)$",
+    "rootDir": "./src"
+  },
+  "dependencies": {
+    "@aztec/circuits.js": "workspace:^",
+    "@aztec/foundation": "workspace:^",
+    "@aztec/noir-compiler": "workspace:^",
+    "@noir-lang/acvm_js": "^0.28.0",
+    "@noir-lang/backend_barretenberg": "^0.7.10",
+    "@noir-lang/noir_js": "^0.16.0",
+    "@noir-lang/noirc_abi": "^0.16.0",
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.5.0",
+    "@rushstack/eslint-patch": "^1.1.4",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^18.7.23",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "files": [
+    "dest",
+    "src",
+    "!*.test.*"
+  ],
+  "types": "./dest/index.d.ts",
+  "engines": {
+    "node": ">=18"
+  }
+}

yarn-project/noir-private-kernel/src/Nargo.toml

@@ -0,0 +1,7 @@
+[workspace]
+members = [
+    "crates/private-kernel-lib",
+    "crates/private-kernel-init",
+    "crates/private-kernel-ordering",
+    "crates/private-kernel-inner",
+]

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/add-is-zero.nr

@@ -0,0 +1 @@
+add a is_zero and is_one method to field for devex

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/array_len.nr

@@ -0,0 +1 @@
+array.len() should return a u64

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/devex-bug-catching.nr

@@ -0,0 +1,7 @@
+When an array is passed in, it is copied in and so if it is written to and not read from, 
+we should get an error saying:
+
+array written to, but never read.
+
+This may prompt the developer to change fn foo(x : [Field ; 2]) to fn foo(x : &mut [Field ; 2]) or to return it 
+fn foo(x : [Field ; 2]) -> [Field ;2] 

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/devex-document-to_le_bits.nr

@@ -0,0 +1 @@
+document parameters for to_le_bits and to_le_bytes

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/devex-integers.nr

@@ -0,0 +1,4 @@
+Could allow for u128 , but then just make it really slow
+so u128 addition would be slow because internally the compiler will be 
+decomposing them.
+Probably possible to just have a u128 struct or something of the kind

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/devex-maxim.nr

@@ -0,0 +1,9 @@
+Ability to template println and assert statements.
+
+assert(foo == bar, "foo was equal to {}, but bar was equal to {}", foo, bar);
+
+and:
+
+fn foo(foo: Field, bar : Field, msg : string) {
+    assert(foo == bar, msg)
+}

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/devex-return-pattern-match.nr

@@ -0,0 +1,7 @@
+fn foo() -> [Field ;2] {
+    [0,0]
+}
+
+Would be a nice devex to be able to do:
+
+let [a, b] = foo();

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/devex-santiago-automatic-deref.nr

@@ -0,0 +1,7 @@
+Santiago mentioned the ability to automatically deref an Address into a Field.
+
+I believe I mentioned something like #[transparent]. The issue with this is 
+that you lose type safety, though perhaps its fine if you opt-in to it, and its 
+only usecase would be to make the part where you input values to the abi smoother.
+
+Not a hard push on this, I just saw a forced usecase for this a minute ago.

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/devex-slice-to-array.nr

@@ -0,0 +1,2 @@
+convert slice to array needs a for loop, not important but would be good to have 
+a method in stdlib

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/devex-test-ignore.nr

@@ -0,0 +1,3 @@
+Would be good to have #[test(ignore)]
+
+to ignore the test

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/devex-turbo-fish.nr

@@ -0,0 +1,19 @@
+fn main(){
+    // This compiles
+    let x : Foo<Field> = Foo {
+        x : 12
+    };
+
+    // TurboFish not allowed
+    let x = Foo::<Field> {
+        x : 12
+    };
+}
+
+struct Foo<N> {
+    x : N,
+}
+
+struct Bar {
+    x : FooField,
+}

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/devex-type-alias.nr

@@ -0,0 +1,6 @@
+// Would be cool if the error message included the type alias
+// that they came from.
+//
+If I do use X as Y;
+And I have an error when initializing Y. The error message speaks about X.
+This is the same with Rust, whether we do it depends on the complexity it adds.

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/export.nr

@@ -0,0 +1,11 @@
+#[abi(export)]
+unconstrained fn abi__compute_hash() {
+
+}
+
+#[abi(export)]
+unconstrained fn abi__compute_block_hash() {
+    abis::compute_hash()
+}
+
+The above allows us to export noir methods to be called from cpp

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/index-on-mutable-array-jake.nr

@@ -0,0 +1,27 @@
+// This is here because x[index] = value is not working in Noir right now
+// when x is &mut
+fn noir_array_set<N>(x : &mut [Field; N], index : u64, value : Field) {
+   // x[index] = value;
+}
+
+error: Expected type an array, found type &mut [Field; N]
+   ┌─ lib.nr:95:15
+   │
+95 │    x[index] = value;
+   │               -----
+   │
+
+
+
+// This is here because x[index] is not working in Noir right now
+// when x is &mut 
+fn noir_array_get<N>(x : &mut [Field; N], index : u64) -> Field {
+   x[index]
+}
+
+error: Expected type Array, found type &mut [Field; N]
+    ┌─ lib.nr:100:4
+    │
+100 │    x[index]
+    │    -
+    │

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/invalid-test-syntax-passing.nr

@@ -0,0 +1,4 @@
+#[test(should_fail_with("array has reached maximum capacit"))]
+fn smoke_test_array_push_capacity(){
+
+}

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/iterate-mutable-array.nr

@@ -0,0 +1,12 @@
+fn array_push_field<T>(mut array : &mut [Field; T], value_to_push : Field) {
+    let mut found_empty_slot = false;
+    for elem in array {
+        if (elem == 0) && (found_empty_slot == false) {
+            found_empty_slot = true;
+            *elem = value_to_push;
+        }
+    }
+    assert(found_empty_slot);
+}
+
+error: Variable elem must be mutable to be assigned to

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/local-dep-does-not-exist

@@ -0,0 +1,9 @@
+util = { path = "../utils" }
+
+If utils does not exist,
+
+It will say:
+
+Cannot read file /mnt/user-data/kev/private-kernel/pki/crates/util/Nargo.toml - does it exist?
+
+It would be good if it also said which package is trying to access that file

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/non-global-type-as-array-size.nr

@@ -0,0 +1,11 @@
+    let num_bytes : Field = 64;
+
+    let input = [0;num_bytes];
+
+
+error: Cannot find a global or generic type parameter named `plain::num_bytes`
+    ┌─ hash.nr:163:20
+    │
+163 │     let input = [0;num_bytes];
+    │                    --------- Only globals or generic type parameters are allowed to be used as an array type's length
+    │

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/re-exports-not-working.nr

@@ -0,0 +1,18 @@
+mod Foo {
+    struct NewType{}
+}
+
+
+mod Bar {
+    use crate::Foo::NewType as BarStruct;
+    use crate::Foo::NewType;
+} 
+
+mod Baz {
+    use crate::Bar::BarStruct;
+    use crate::Bar::NewType;
+}
+
+// Baz is unable to find the Bar re-exports
+// error: Could not resolve 'NewType' in path
+// error: Could not resolve 'BarStruct' in path

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/reexports.nr

@@ -0,0 +1 @@
+check re-exports to shorten use path

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/should-compile-different-namespace.nr

@@ -0,0 +1,16 @@
+
+struct Foo<N> {
+    x : N,
+}
+
+type FooField = Foo<Field>;
+type Foou32 = Foo<u32>;
+
+// These two impls should work since the `hash1` implementations
+// are in different "namespaces".
+impl FooField {
+    fn hash1(self) {}
+}
+impl Foou32 {
+    fn hash1(self) {}
+}

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/should-not-compile.nr

@@ -0,0 +1,6 @@
+struct Foo<N> {
+    x : N,
+}
+
+// Expected: constant provided when a type was expected
+type FooField = Foo<12>;

yarn-project/noir-private-kernel/src/crates/bug-collecting-crate/test-println.nr

@@ -0,0 +1,3 @@
+If I have a println in a test and then an assert follows it.
+
+I get constraint failed, though I do not get the println output