@aztec/bb-prover 0.0.0-test.0

package/package.json

@@ -0,0 +1,111 @@
+{
+  "name": "@aztec/bb-prover",
+  "version": "0.0.0-test.0",
+  "type": "module",
+  "exports": {
+    ".": "./dest/index.js",
+    "./wasm/bundle": "./dest/wasm/bundle.js",
+    "./wasm/lazy": "./dest/wasm/lazy.js",
+    "./prover": "./dest/prover/index.js",
+    "./verifier": "./dest/verifier/index.js",
+    "./test": "./dest/test/index.js",
+    "./config": "./dest/config.js"
+  },
+  "bin": {
+    "bb-cli": "./dest/bb/index.js"
+  },
+  "typedocOptions": {
+    "entryPoints": [
+      "./src/index.ts"
+    ],
+    "name": "BB Prover",
+    "tsconfig": "./tsconfig.json"
+  },
+  "inherits": [
+    "../package.common.json"
+  ],
+  "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 eslint --fix ./src && run -T prettier -w ./src",
+    "bb": "node --no-warnings ./dest/bb/index.js",
+    "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ../node_modules/.bin/jest --passWithNoTests --maxWorkers=${JEST_MAX_WORKERS:-8}"
+  },
+  "jest": {
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.[cm]?js$": "$1"
+    },
+    "testRegex": "./src/.*\\.test\\.(js|mjs|ts)$",
+    "rootDir": "./src",
+    "transform": {
+      "^.+\\.tsx?$": [
+        "@swc/jest",
+        {
+          "jsc": {
+            "parser": {
+              "syntax": "typescript",
+              "decorators": true
+            },
+            "transform": {
+              "decoratorVersion": "2022-03"
+            }
+          }
+        }
+      ]
+    },
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ],
+    "reporters": [
+      "default"
+    ],
+    "testTimeout": 120000,
+    "setupFiles": [
+      "../../foundation/src/jest/setup.mjs"
+    ]
+  },
+  "dependencies": {
+    "@aztec/bb.js": "0.0.0-test.0",
+    "@aztec/constants": "0.0.0-test.0",
+    "@aztec/foundation": "0.0.0-test.0",
+    "@aztec/noir-protocol-circuits-types": "0.0.0-test.0",
+    "@aztec/simulator": "0.0.0-test.0",
+    "@aztec/stdlib": "0.0.0-test.0",
+    "@aztec/telemetry-client": "0.0.0-test.0",
+    "@aztec/world-state": "0.0.0-test.0",
+    "@msgpack/msgpack": "^3.0.0-beta2",
+    "commander": "^12.1.0",
+    "pako": "^2.1.0",
+    "source-map-support": "^0.5.21",
+    "tslib": "^2.4.0",
+    "@aztec/noir-noirc_abi": "0.0.0-test.0",
+    "@aztec/noir-types": "0.0.0-test.0"
+  },
+  "devDependencies": {
+    "@aztec/ethereum": "0.0.0-test.0",
+    "@aztec/kv-store": "0.0.0-test.0",
+    "@aztec/noir-contracts.js": "0.0.0-test.0",
+    "@aztec/protocol-contracts": "0.0.0-test.0",
+    "@jest/globals": "^29.5.0",
+    "@types/jest": "^29.5.0",
+    "@types/memdown": "^3.0.0",
+    "@types/node": "^18.7.23",
+    "@types/source-map-support": "^0.5.10",
+    "jest": "^29.5.0",
+    "jest-mock-extended": "^3.0.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4",
+    "viem": "2.22.8"
+  },
+  "files": [
+    "dest",
+    "src",
+    "!*.test.*"
+  ],
+  "types": "./dest/index.d.ts",
+  "engines": {
+    "node": ">=18"
+  }
+}

package/src/avm_proving_tests/avm_proving_tester.ts

@@ -0,0 +1,170 @@
+import { PublicTxSimulationTester, type TestEnqueuedCall } from '@aztec/simulator/public/fixtures';
+import { SimpleContractDataSource, WorldStateDB } from '@aztec/simulator/server';
+import type { AvmCircuitInputs } from '@aztec/stdlib/avm';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { MerkleTreeWriteOperations } from '@aztec/stdlib/interfaces/server';
+import { makeAvmCircuitInputs } from '@aztec/stdlib/testing';
+import { VerificationKeyData } from '@aztec/stdlib/vks';
+import { NativeWorldStateService } from '@aztec/world-state';
+
+import fs from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import path from 'path';
+
+import {
+  type BBResult,
+  type BBSuccess,
+  BB_RESULT,
+  generateAvmProof,
+  generateAvmProofV2,
+  verifyAvmProof,
+  verifyAvmProofV2,
+} from '../bb/execute.js';
+import { extractAvmVkData } from '../verification_key/verification_key_data.js';
+
+const BB_PATH = path.resolve('../../barretenberg/cpp/build/bin/bb');
+
+export class AvmProvingTester extends PublicTxSimulationTester {
+  constructor(
+    private bbWorkingDirectory: string,
+    private checkCircuitOnly: boolean,
+    worldStateDB: WorldStateDB,
+    contractDataSource: SimpleContractDataSource,
+    merkleTrees: MerkleTreeWriteOperations,
+  ) {
+    super(worldStateDB, contractDataSource, merkleTrees);
+  }
+
+  static override async create(checkCircuitOnly: boolean = false) {
+    const bbWorkingDirectory = await fs.mkdtemp(path.join(tmpdir(), 'bb-'));
+
+    const contractDataSource = new SimpleContractDataSource();
+    const merkleTrees = await (await NativeWorldStateService.tmp()).fork();
+    const worldStateDB = new WorldStateDB(merkleTrees, contractDataSource);
+    return new AvmProvingTester(bbWorkingDirectory, checkCircuitOnly, worldStateDB, contractDataSource, merkleTrees);
+  }
+
+  async prove(avmCircuitInputs: AvmCircuitInputs): Promise<BBResult> {
+    // Then we prove.
+    const proofRes = await generateAvmProof(
+      BB_PATH,
+      this.bbWorkingDirectory,
+      avmCircuitInputs,
+      this.logger,
+      this.checkCircuitOnly,
+    );
+    if (proofRes.status === BB_RESULT.FAILURE) {
+      this.logger.error(`Proof generation failed: ${proofRes.reason}`);
+    }
+    return proofRes;
+  }
+
+  async verify(proofRes: BBSuccess): Promise<BBResult> {
+    if (this.checkCircuitOnly) {
+      // Skip verification if we're only checking the circuit.
+      // Check-circuit doesn't generate a proof to verify.
+      return proofRes;
+    }
+    // Then we test VK extraction and serialization.
+    const succeededRes = proofRes as BBSuccess;
+    const vkData = await extractAvmVkData(succeededRes.vkPath!);
+    VerificationKeyData.fromBuffer(vkData.toBuffer());
+
+    // Then we verify.
+    const rawVkPath = path.join(succeededRes.vkPath!, 'vk');
+    return await verifyAvmProof(BB_PATH, succeededRes.proofPath!, rawVkPath, this.logger);
+  }
+
+  public async simProveVerify(
+    sender: AztecAddress,
+    setupCalls: TestEnqueuedCall[],
+    appCalls: TestEnqueuedCall[],
+    teardownCall: TestEnqueuedCall | undefined,
+    expectRevert: boolean | undefined,
+    feePayer = sender,
+  ) {
+    const simRes = await this.simulateTx(sender, setupCalls, appCalls, teardownCall, feePayer);
+    expect(simRes.revertCode.isOK()).toBe(expectRevert ? false : true);
+    const avmCircuitInputs = simRes.avmProvingRequest.inputs;
+    const provingRes = await this.prove(avmCircuitInputs);
+    expect(provingRes.status).toEqual(BB_RESULT.SUCCESS);
+    const verificationRes = await this.verify(provingRes as BBSuccess);
+    expect(verificationRes.status).toBe(BB_RESULT.SUCCESS);
+  }
+
+  public async simProveVerifyAppLogic(appCall: TestEnqueuedCall, expectRevert?: boolean) {
+    const simRes = await this.simulateTx(/*sender=*/ AztecAddress.fromNumber(42), /*setupCalls=*/ [], [appCall]);
+    expect(simRes.revertCode.isOK()).toBe(expectRevert ? false : true);
+
+    const avmCircuitInputs = simRes.avmProvingRequest.inputs;
+    const provingRes = await this.prove(avmCircuitInputs);
+    expect(provingRes.status).toEqual(BB_RESULT.SUCCESS);
+
+    const verificationRes = await this.verify(provingRes as BBSuccess);
+    expect(verificationRes.status).toBe(BB_RESULT.SUCCESS);
+  }
+}
+
+export class AvmProvingTesterV2 extends PublicTxSimulationTester {
+  constructor(
+    private bbWorkingDirectory: string,
+    worldStateDB: WorldStateDB,
+    contractDataSource: SimpleContractDataSource,
+    merkleTrees: MerkleTreeWriteOperations,
+  ) {
+    super(worldStateDB, contractDataSource, merkleTrees);
+  }
+
+  static override async create() {
+    const bbWorkingDirectory = await fs.mkdtemp(path.join(tmpdir(), 'bb-'));
+
+    const contractDataSource = new SimpleContractDataSource();
+    const merkleTrees = await (await NativeWorldStateService.tmp()).fork();
+    const worldStateDB = new WorldStateDB(merkleTrees, contractDataSource);
+    return new AvmProvingTesterV2(bbWorkingDirectory, worldStateDB, contractDataSource, merkleTrees);
+  }
+
+  async proveV2(avmCircuitInputs: AvmCircuitInputs): Promise<BBResult> {
+    // Then we prove.
+    const proofRes = await generateAvmProofV2(BB_PATH, this.bbWorkingDirectory, avmCircuitInputs, this.logger);
+    if (proofRes.status === BB_RESULT.FAILURE) {
+      this.logger.error(`Proof generation failed: ${proofRes.reason}`);
+    }
+    expect(proofRes.status).toEqual(BB_RESULT.SUCCESS);
+    return proofRes as BBSuccess;
+  }
+
+  async verifyV2(proofRes: BBSuccess): Promise<BBResult> {
+    // TODO: Placeholder for now. They get ignored in C++.
+    const inputs = await makeAvmCircuitInputs();
+
+    const rawVkPath = path.join(proofRes.vkPath!, 'vk');
+    return await verifyAvmProofV2(
+      BB_PATH,
+      this.bbWorkingDirectory,
+      proofRes.proofPath!,
+      inputs.publicInputs,
+      rawVkPath,
+      this.logger,
+    );
+  }
+
+  public async simProveVerifyV2(
+    sender: AztecAddress,
+    setupCalls: TestEnqueuedCall[],
+    appCalls: TestEnqueuedCall[],
+    teardownCall: TestEnqueuedCall | undefined,
+    expectRevert: boolean | undefined,
+    feePayer = sender,
+  ) {
+    const simRes = await this.simulateTx(sender, setupCalls, appCalls, teardownCall, feePayer);
+    expect(simRes.revertCode.isOK()).toBe(expectRevert ? false : true);
+
+    const avmCircuitInputs = simRes.avmProvingRequest.inputs;
+    const provingRes = await this.proveV2(avmCircuitInputs);
+    expect(provingRes.status).toEqual(BB_RESULT.SUCCESS);
+
+    const verificationRes = await this.verifyV2(provingRes as BBSuccess);
+    expect(verificationRes.status).toBe(BB_RESULT.SUCCESS);
+  }
+}

package/src/bb/cli.ts

@@ -0,0 +1,32 @@
+import type { LogFn } from '@aztec/foundation/log';
+import { ClientCircuitArtifacts } from '@aztec/noir-protocol-circuits-types/client/bundle';
+import { ServerCircuitArtifacts } from '@aztec/noir-protocol-circuits-types/server';
+import type { ProtocolArtifact } from '@aztec/noir-protocol-circuits-types/types';
+import type { NoirCompiledCircuit } from '@aztec/stdlib/noir';
+
+import { Command } from 'commander';
+
+export const ProtocolCircuitArtifacts: Record<ProtocolArtifact, NoirCompiledCircuit> = {
+  ...ClientCircuitArtifacts,
+  ...ServerCircuitArtifacts,
+};
+
+/**
+ * Returns commander program that defines the CLI.
+ * @param log - Console logger.
+ * @returns The CLI.
+ */
+export function getProgram(log: LogFn): Command {
+  const program = new Command('bb-cli');
+
+  program.description('CLI for interacting with Barretenberg.');
+
+  program
+    .command('protocol-circuits')
+    .description('Lists the available protocol circuit artifacts')
+    .action(() => {
+      log(Object.keys(ProtocolCircuitArtifacts).reduce((prev: string, x: string) => prev.concat(`\n${x}`)));
+    });
+
+  return program;
+}