feat(compiler): adds Aztec noir compiler (#438)

* wip: added noir wasm to compile in typescript * feat(compiler): first compiler version * chore: added prettierignore * docs: added tsdoc * chore(compiler): fixed the executable * chore(compiler): add to CI * docs(contracts): added docs for script * fix: fixed foundation abi import * chore: fix path to module * chore: update noir_wasm * chore: updated packages with yarn prepare * fix: update abi import * docs: added jsdoc * refactor: address some pr comments
AztecProtocol · May 5, 2023 · 7542d85 · 7542d85
1 parent 2ceba53
commit 7542d85
Show file tree

Hide file tree

Showing 62 changed files with 560 additions and 168 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -232,6 +232,17 @@ jobs:
           name: "Build and test"
           command: build noir-contracts
 
+  noir-compiler:
+    machine:
+      image: ubuntu-2004:202010-01
+    resource_class: large
+    steps:
+      - *checkout
+      - *setup_env
+      - run:
+          name: "Build and test"
+          command: build noir-compiler
+
   world-state:
     machine:
       image: ubuntu-2004:202010-01
@@ -456,6 +467,7 @@ workflows:
       - merkle-tree: *yarn_project
       - p2p: *yarn_project
       - noir-contracts: *yarn_project
+      - noir-compiler: *yarn_project
       - sequencer-client: *yarn_project
       - types: *yarn_project
       - circuits-js: *yarn_project

diff --git a/build_manifest.json b/build_manifest.json
@@ -168,6 +168,17 @@
     "rebuildPatterns": ["^yarn-project/noir-contracts/"],
     "dependencies": ["foundation"]
   },
+  "noir-compiler": {
+    "buildDir": "yarn-project",
+    "projectDir": "yarn-project/noir-compiler",
+    "dockerfile": "noir-compiler/Dockerfile",
+    "rebuildPatterns": [
+      "^yarn-project/noir-compiler/"
+    ],
+    "dependencies": [
+      "foundation"
+    ]
+  },
   "p2p": {
     "buildDir": "yarn-project",
     "projectDir": "yarn-project/p2p",

diff --git a/yarn-project/acir-simulator/src/abi_coder/decoder.ts b/yarn-project/acir-simulator/src/abi_coder/decoder.ts
@@ -1,5 +1,5 @@
 import { Fr } from '@aztec/foundation/fields';
-import { ABIType, FunctionAbi } from '@aztec/noir-contracts';
+import { ABIType, FunctionAbi } from '@aztec/foundation/abi';
 
 /**
  * Decodes return values from a function call.

diff --git a/yarn-project/acir-simulator/src/abi_coder/encoder.ts b/yarn-project/acir-simulator/src/abi_coder/encoder.ts
@@ -1,7 +1,6 @@
 import { ARGS_LENGTH } from '@aztec/circuits.js';
 import { Fr } from '@aztec/foundation/fields';
-
-import { ABIType, FunctionAbi } from '@aztec/noir-contracts';
+import { ABIType, FunctionAbi } from '@aztec/foundation/abi';
 
 /**
  * Encodes arguments for a function call.

diff --git a/yarn-project/acir-simulator/src/abi_coder/index.ts b/yarn-project/acir-simulator/src/abi_coder/index.ts
@@ -1,8 +1,13 @@
-import { ABIType } from '@aztec/noir-contracts';
+import { ABIType } from '@aztec/foundation/abi';
 
 export * from './encoder.js';
 export * from './decoder.js';
 
+/**
+ * Get the size of an ABI type in field elements.
+ * @param type - The ABI type.
+ * @returns The size of the type in field elements.
+ */
 export function sizeOfType(type: ABIType): number {
   switch (type.kind) {
     case 'field':

diff --git a/yarn-project/acir-simulator/src/client/db_oracle.ts b/yarn-project/acir-simulator/src/client/db_oracle.ts
@@ -1,7 +1,7 @@
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
-import { FunctionAbi } from '@aztec/noir-contracts';
+import { FunctionAbi } from '@aztec/foundation/abi';
 
 /**
  * The format that noir contracts use to get notes.

diff --git a/yarn-project/acir-simulator/src/client/private_execution.ts b/yarn-project/acir-simulator/src/client/private_execution.ts
@@ -9,7 +9,7 @@ import {
 } from '../acvm/index.js';
 import { CallContext, PrivateCallStackItem, FunctionData } from '@aztec/circuits.js';
 import { extractPublicInputs, frToAztecAddress, frToSelector } from '../acvm/deserialize.js';
-import { FunctionAbi } from '@aztec/noir-contracts';
+import { FunctionAbi } from '@aztec/foundation/abi';
 import { createDebugLogger } from '@aztec/foundation/log';
 import { decodeReturnValues } from '../abi_coder/decoder.js';
 import { ClientTxExecutionContext } from './client_execution_context.js';

diff --git a/yarn-project/acir-simulator/src/client/simulator.ts b/yarn-project/acir-simulator/src/client/simulator.ts
@@ -1,5 +1,5 @@
 import { CallContext, PrivateHistoricTreeRoots, TxRequest } from '@aztec/circuits.js';
-import { FunctionAbi, FunctionType } from '@aztec/noir-contracts';
+import { FunctionAbi, FunctionType } from '@aztec/foundation/abi';
 import { DBOracle } from './db_oracle.js';
 import { PrivateFunctionExecution, ExecutionResult } from './private_execution.js';
 import { BarretenbergWasm } from '@aztec/barretenberg.js/wasm';

diff --git a/yarn-project/acir-simulator/src/client/unconstrained_execution.ts b/yarn-project/acir-simulator/src/client/unconstrained_execution.ts
@@ -1,7 +1,7 @@
 import { ACVMField, acvm, fromACVMField, toACVMField, toACVMWitness } from '../acvm/index.js';
 import { CallContext, FunctionData } from '@aztec/circuits.js';
 import { frToAztecAddress, frToNumber } from '../acvm/deserialize.js';
-import { FunctionAbi } from '@aztec/noir-contracts';
+import { FunctionAbi } from '@aztec/foundation/abi';
 import { createDebugLogger } from '@aztec/foundation/log';
 import { decodeReturnValues } from '../abi_coder/decoder.js';
 import { ClientTxExecutionContext } from './client_execution_context.js';

diff --git a/yarn-project/acir-simulator/src/public/index.test.ts b/yarn-project/acir-simulator/src/public/index.test.ts
@@ -4,7 +4,7 @@ import { CallContext, FunctionData } from '@aztec/circuits.js';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
-import { FunctionAbi } from '@aztec/noir-contracts';
+import { FunctionAbi } from '@aztec/foundation/abi';
 import { ChildAbi, ParentAbi, PublicTokenContractAbi } from '@aztec/noir-contracts/examples';
 import { MockProxy, mock } from 'jest-mock-extended';
 import { default as memdown, type MemDown } from 'memdown';

diff --git a/yarn-project/aztec-rpc/src/abi_coder/index.ts b/yarn-project/aztec-rpc/src/abi_coder/index.ts
@@ -1,5 +1,5 @@
 import { keccak } from '@aztec/foundation/crypto';
-import { ABIParameter } from '@aztec/noir-contracts';
+import { ABIParameter } from '@aztec/foundation/abi';
 
 /**
  * Generate a function signature string for a given function name and parameters.

diff --git a/yarn-project/aztec-rpc/src/account_state/account_state.ts b/yarn-project/aztec-rpc/src/account_state/account_state.ts
@@ -7,7 +7,7 @@ import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { Fr, Point } from '@aztec/foundation/fields';
 import { createDebugLogger } from '@aztec/foundation/log';
 import { ConstantKeyPair, KeyPair } from '@aztec/key-store';
-import { FunctionType } from '@aztec/noir-contracts';
+import { FunctionType } from '@aztec/foundation/abi';
 import {
   EncodedContractFunction,
   INITIAL_L2_BLOCK_NUM,

diff --git a/yarn-project/aztec-rpc/src/aztec_rpc_client/aztec_rpc_client.ts b/yarn-project/aztec-rpc/src/aztec_rpc_client/aztec_rpc_client.ts
@@ -1,6 +1,6 @@
 import { AztecAddress, EthAddress, Fr, TxRequest, EcdsaSignature } from '@aztec/circuits.js';
 import { Tx, TxHash } from '@aztec/types';
-import { ContractAbi } from '@aztec/noir-contracts';
+import { ContractAbi } from '@aztec/foundation/abi';
 import { TxReceipt } from '../tx/index.js';
 import { Point } from '@aztec/foundation/fields';
 

diff --git a/yarn-project/aztec-rpc/src/aztec_rpc_server/aztec_rpc_server.ts b/yarn-project/aztec-rpc/src/aztec_rpc_server/aztec_rpc_server.ts
@@ -13,7 +13,7 @@ import {
 import { Fr, Point } from '@aztec/foundation/fields';
 import { createDebugLogger } from '@aztec/foundation/log';
 import { KeyStore } from '@aztec/key-store';
-import { ContractAbi, FunctionType } from '@aztec/noir-contracts';
+import { ContractAbi, FunctionType } from '@aztec/foundation/abi';
 import { Tx, TxHash } from '@aztec/types';
 import { AztecRPCClient, DeployedContract } from '../aztec_rpc_client/index.js';
 import { toContractDao } from '../contract_database/index.js';

diff --git a/yarn-project/aztec-rpc/src/contract_database/contract_dao.ts b/yarn-project/aztec-rpc/src/contract_database/contract_dao.ts
@@ -1,5 +1,5 @@
-import { ContractAbi, FunctionAbi } from '@aztec/noir-contracts';
 import { generateFunctionSelector } from '../abi_coder/index.js';
+import { ContractAbi, FunctionAbi } from '@aztec/foundation/abi';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { EthAddress } from '@aztec/foundation/eth-address';
 

diff --git a/yarn-project/aztec-rpc/src/contract_tree/contract_tree.ts b/yarn-project/aztec-rpc/src/contract_tree/contract_tree.ts
@@ -17,10 +17,10 @@ import {
   hashVK,
 } from '@aztec/circuits.js/abis';
 import { CircuitsWasm } from '@aztec/circuits.js/wasm';
-import { ContractAbi, FunctionType } from '@aztec/noir-contracts';
 import { generateFunctionSelector } from '../abi_coder/index.js';
 import { ContractDao, ContractFunctionDao } from '../contract_database/index.js';
 import { computeFunctionTreeData } from './function_tree_data.js';
+import { ContractAbi, FunctionType } from '@aztec/foundation/abi';
 import { Fr } from '@aztec/foundation/fields';
 import { keccak } from '@aztec/foundation/crypto';
 import { EthAddress } from '@aztec/foundation/eth-address';

diff --git a/yarn-project/aztec-rpc/src/simulator_oracle/index.ts b/yarn-project/aztec-rpc/src/simulator_oracle/index.ts
@@ -2,7 +2,7 @@ import { DBOracle } from '@aztec/acir-simulator';
 import { AztecNode } from '@aztec/aztec-node';
 import { AztecAddress, EthAddress, Fr } from '@aztec/circuits.js';
 import { KeyPair } from '@aztec/key-store';
-import { FunctionAbi } from '@aztec/noir-contracts';
+import { FunctionAbi } from '@aztec/foundation/abi';
 import { ContractDataOracle } from '../contract_data_oracle/index.js';
 import { Database } from '../database/index.js';
 

diff --git a/yarn-project/aztec.js/src/contract/checker.ts b/yarn-project/aztec.js/src/contract/checker.ts
@@ -1,4 +1,4 @@
-import { ABIType, BasicType, ContractAbi, StructType } from '@aztec/noir-contracts';
+import { ABIType, BasicType, ContractAbi, StructType } from '@aztec/foundation/abi';
 
 /**
  * Represents a type derived from input type T with the 'kind' property removed.

diff --git a/yarn-project/aztec.js/src/contract/contract.test.ts b/yarn-project/aztec.js/src/contract/contract.test.ts
@@ -8,11 +8,11 @@ import {
   TxReceipt,
   TxRequest,
 } from '@aztec/aztec-rpc';
-import { ABIParameterVisibility, ContractAbi, FunctionType } from '@aztec/noir-contracts';
 import { mock } from 'jest-mock-extended';
 
 import { EcdsaSignature } from '@aztec/circuits.js';
 import { Contract } from './contract.js';
+import { ABIParameterVisibility, ContractAbi, FunctionType } from '@aztec/foundation/abi';
 import { randomBytes } from '@aztec/foundation/crypto';
 
 describe('Contract Class', () => {

diff --git a/yarn-project/aztec.js/src/contract/contract.ts b/yarn-project/aztec.js/src/contract/contract.ts
@@ -1,5 +1,5 @@
 import { AztecRPCClient, DeployedContract, generateFunctionSelector } from '@aztec/aztec-rpc';
-import { ContractAbi, FunctionAbi } from '@aztec/noir-contracts';
+import { ContractAbi, FunctionAbi } from '@aztec/foundation/abi';
 import { ContractFunctionInteraction } from './contract_function_interaction.js';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { EthAddress } from '@aztec/foundation/eth-address';

diff --git a/yarn-project/aztec.js/src/contract/contract_function_interaction.ts b/yarn-project/aztec.js/src/contract/contract_function_interaction.ts
@@ -1,6 +1,6 @@
 import { AztecRPCClient, Tx, TxHash, TxRequest } from '@aztec/aztec-rpc';
 import { AztecAddress, EcdsaSignature, Fr } from '@aztec/circuits.js';
-import { FunctionType } from '@aztec/noir-contracts';
+import { FunctionType } from '@aztec/foundation/abi';
 import { SentTx } from './sent_tx.js';
 
 /**

diff --git a/yarn-project/aztec.js/src/contract_deployer/contract_deployer.test.ts b/yarn-project/aztec.js/src/contract_deployer/contract_deployer.test.ts
@@ -1,6 +1,6 @@
 import { AztecRPCClient, Tx, TxHash, TxReceipt, TxRequest } from '@aztec/aztec-rpc';
 import { AztecAddress, EcdsaSignature, EthAddress, Fr } from '@aztec/circuits.js';
-import { ContractAbi, FunctionType } from '@aztec/noir-contracts';
+import { ContractAbi, FunctionType } from '@aztec/foundation/abi';
 import { randomBytes } from 'crypto';
 import { mock } from 'jest-mock-extended';
 import { ContractDeployer } from './contract_deployer.js';

diff --git a/yarn-project/aztec.js/src/contract_deployer/contract_deployer.ts b/yarn-project/aztec.js/src/contract_deployer/contract_deployer.ts
@@ -1,5 +1,5 @@
 import { AztecRPCClient } from '@aztec/aztec-rpc';
-import { ContractAbi } from '@aztec/noir-contracts';
+import { ContractAbi } from '@aztec/foundation/abi';
 import { DeployMethod } from './deploy_method.js';
 
 /**

diff --git a/yarn-project/aztec.js/src/contract_deployer/deploy_method.ts b/yarn-project/aztec.js/src/contract_deployer/deploy_method.ts
@@ -1,5 +1,5 @@
 import { AztecRPCClient } from '@aztec/aztec-rpc';
-import { ContractAbi, FunctionType } from '@aztec/noir-contracts';
+import { ContractAbi, FunctionType } from '@aztec/foundation/abi';
 import { ContractFunctionInteraction, SendMethodOptions } from '../contract/index.js';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';

diff --git a/yarn-project/end-to-end/src/e2e_block_building.test.ts b/yarn-project/end-to-end/src/e2e_block_building.test.ts
@@ -3,7 +3,6 @@ import { AztecRPCServer, ContractDeployer, Fr, TxStatus } from '@aztec/aztec.js'
 import { mnemonicToAccount } from 'viem/accounts';
 import { createAztecRpcServer } from './create_aztec_rpc_client.js';
 import { deployL1Contracts } from './deploy_l1_contracts.js';
-import { ContractAbi } from '@aztec/noir-contracts';
 import { TestContractAbi } from '@aztec/noir-contracts/examples';
 import times from 'lodash.times';
 import { createDebugLogger } from '@aztec/foundation/log';
@@ -18,7 +17,7 @@ describe('e2e_block_building', () => {
   let node: AztecNode;
   let aztecRpcServer: AztecRPCServer;
 
-  const abi = TestContractAbi as ContractAbi;
+  const abi = TestContractAbi;
 
   beforeEach(async () => {
     const account = mnemonicToAccount(MNEMONIC);

diff --git a/yarn-project/end-to-end/src/e2e_nested_contract.test.ts b/yarn-project/end-to-end/src/e2e_nested_contract.test.ts
@@ -1,7 +1,7 @@
 import { AztecNode, getConfigEnvVars } from '@aztec/aztec-node';
 import { AztecAddress, AztecRPCServer, Contract, ContractDeployer, Fr, TxStatus } from '@aztec/aztec.js';
 import { createDebugLogger } from '@aztec/foundation/log';
-import { ContractAbi } from '@aztec/noir-contracts';
+import { ContractAbi } from '@aztec/foundation/abi';
 import { ChildAbi, ParentAbi } from '@aztec/noir-contracts/examples';
 
 import { mnemonicToAccount } from 'viem/accounts';

diff --git a/yarn-project/foundation/package.json b/yarn-project/foundation/package.json
@@ -8,6 +8,7 @@
     "./eslint": "./.eslintrc.cjs",
     "./eslint-legacy": "./.eslintrc.legacy.cjs",
     "./prettier": "./.prettierrc.json",
+    "./abi": "./dest/abi/index.js",
     "./async-map": "./dest/async-map/index.js",
     "./aztec-address": "./dest/aztec-address/index.js",
     "./collection": "./dest/collection/index.js",

diff --git a/yarn-project/noir-contracts/src/abi.ts → yarn-project/foundation/src/abi/index.ts b/yarn-project/noir-contracts/src/abi.ts → yarn-project/foundation/src/abi/index.ts
diff --git a/yarn-project/noir-compiler/.eslintrc.cjs b/yarn-project/noir-compiler/.eslintrc.cjs
@@ -0,0 +1 @@
+module.exports = require('@aztec/foundation/eslint');
diff --git a/yarn-project/noir-compiler/.gitignore b/yarn-project/noir-compiler/.gitignore
@@ -0,0 +1,4 @@
+target/
+proofs/
+Prover.toml
+Verifier.toml
diff --git a/yarn-project/noir-compiler/.prettierignore b/yarn-project/noir-compiler/.prettierignore
@@ -0,0 +1 @@
+src/fixtures
diff --git a/yarn-project/noir-compiler/Dockerfile b/yarn-project/noir-compiler/Dockerfile
@@ -0,0 +1,15 @@
+FROM 278380418400.dkr.ecr.eu-west-2.amazonaws.com/yarn-project-base AS builder
+
+COPY . .
+
+WORKDIR /usr/src/yarn-project/noir-compiler
+RUN yarn build && yarn formatting && yarn test
+
+# Prune dev dependencies. See comment in base image.
+RUN yarn cache clean
+RUN yarn workspaces focus --production > /dev/null
+
+FROM node:18-alpine
+COPY --from=builder /usr/src/yarn-project/noir-compiler /usr/src/yarn-project/noir-compiler
+WORKDIR /usr/src/yarn-project/noir-compiler
+ENTRYPOINT ["yarn"]
diff --git a/yarn-project/noir-compiler/README.md b/yarn-project/noir-compiler/README.md
@@ -0,0 +1,15 @@
+# Aztec Noir compiler
+
+The Aztec noir compiler compiles noir contracts using noir_wasm and outputs Aztec formatted contract ABIs.
+
+## Installation
+
+To install the package, just run `yarn add @aztec/noir-compiler`.
+
+## Usage
+
+To run the compiler as a CLI tool, run `yarn aztec_noir_compiler compile <path_to_noir_contract_crate>`
+
+## Status
+
+Currently, this noir compiler uses noir master branch. It's not compatible yet with the test contracts for Aztec that are in the `noir-contracts` package, that need to be built following its README.md instructions.
diff --git a/yarn-project/noir-compiler/package.json b/yarn-project/noir-compiler/package.json
@@ -0,0 +1,61 @@
+{
+  "name": "@aztec/noir-compiler",
+  "version": "0.0.0",
+  "type": "module",
+  "exports": "./dest/index.js",
+  "typedoc": {
+    "entryPoint": "./src/index.ts",
+    "displayName": "Aztec noir compiler",
+    "tsconfig": "./tsconfig.json"
+  },
+  "bin": {
+    "aztec_noir_compiler": "dest/cli.js"
+  },
+  "scripts": {
+    "prepare": "node ../yarn-project-base/scripts/update_build_manifest.mjs package.json",
+    "prepare:check": "node ../yarn-project-base/scripts/update_build_manifest.mjs package.json --check",
+    "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",
+    "test": "DEBUG=wasm 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}/.*)\\.js$": "$1"
+    },
+    "testRegex": "./src/.*\\.test\\.ts$",
+    "rootDir": "./src"
+  },
+  "dependencies": {
+    "@aztec/foundation": "workspace:^",
+    "@noir-lang/noir-source-resolver": "1.1.1",
+    "@noir-lang/noir_wasm": "0.5.1-9740f54",
+    "commander": "^9.0.0",
+    "fs-extra": "^11.1.1",
+    "toml": "^3.0.0",
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.5.0",
+    "@rushstack/eslint-patch": "^1.1.4",
+    "@types/fs-extra": "^11.0.1",
+    "@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"
+}