feat: simulator split (#11144)

- Modularises `@aztec/simulator` to provide `/client` and `/server`bundles. - Makes both `bb-prover` and `pxe` take a `SimulatorProvider` as an argument, so web bundles can initialise a single wasm version on a common entrypoint. - Uses said simulator provider for everything! - Unifies aztec-packages to always use `acvm_js` to execute circuits, instead of sometimes `noir_js`(for protocol circuits). This forces some code repetiton ATM, but again, unifies codepaths and used dependencies. All of this allows us to again simplify the the web bundles and avoid the need for weird wasm initialization hacks. Async loading is also now properly supported, which allows us to display meaningful content on a webapp near instantly.
AztecProtocol · Jan 11, 2025 · 9b99126 · 9b99126
1 parent 8a927eb
commit 9b99126
Show file tree

Hide file tree

Showing 73 changed files with 408 additions and 257 deletions.
diff --git a/boxes/boxes/vite/package.json b/boxes/boxes/vite/package.json
@@ -21,9 +21,7 @@
     "@aztec/key-store": "link:../../../yarn-project/key-store",
     "@aztec/kv-store": "portal:../../../yarn-project/kv-store",
     "@aztec/pxe": "link:../../../yarn-project/pxe",
-    "@noir-lang/acvm_js": "link:../../../noir/packages/acvm_js",
-    "@noir-lang/noirc_abi": "link:../../../noir/packages/noirc_abi",
-    "buffer": "^6.0.3",
+    "@aztec/simulator": "link:../../../yarn-project/simulator",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "react-toastify": "^10.0.6"

diff --git a/boxes/boxes/vite/src/App.tsx b/boxes/boxes/vite/src/App.tsx
@@ -2,33 +2,13 @@ import { ToastContainer } from "react-toastify";
 import "react-toastify/dist/ReactToastify.css";
 import "./App.css";
 import { Home } from "./pages/home";
-import { useEffect, useState } from "react";
-import initACVM from "@noir-lang/acvm_js/web/acvm_js";
-import initABI from "@noir-lang/noirc_abi/web/noirc_abi_wasm";
-import acvmURL from "@noir-lang/acvm_js/web/acvm_js_bg.wasm?url";
-import abiURL from "@noir-lang/noirc_abi/web/noirc_abi_wasm_bg.wasm?url";
-
-const InitWasm = ({ children }: any) => {
-  const [init, setInit] = useState(false);
-  useEffect(() => {
-    (async () => {
-      await Promise.all([
-        initACVM(new URL(acvmURL, import.meta.url).toString()),
-        initABI(new URL(abiURL, import.meta.url).toString()),
-      ]);
-      setInit(true);
-    })();
-  }, []);
-
-  return <div>{init && children}</div>;
-};
 
 function App() {
   return (
-    <InitWasm>
+    <>
       <Home />
       <ToastContainer />
-    </InitWasm>
+    </>
   );
 }
 

diff --git a/boxes/boxes/vite/src/config.ts b/boxes/boxes/vite/src/config.ts
@@ -1,5 +1,4 @@
 import {
-  AztecNode,
   Fr,
   createLogger,
   deriveMasterIncomingViewingSecretKey,
@@ -12,10 +11,10 @@ import { PXEService } from "@aztec/pxe/service";
 import { PXEServiceConfig, getPXEServiceConfig } from "@aztec/pxe/config";
 import { KVPxeDatabase } from "@aztec/pxe/database";
 import { KeyStore } from "@aztec/key-store";
-import { PrivateKernelProver } from "@aztec/circuit-types";
 import { L2TipsStore } from "@aztec/kv-store/stores";
 import { createStore } from "@aztec/kv-store/indexeddb";
 import { BBWASMLazyPrivateKernelProver } from "@aztec/bb-prover/wasm/lazy";
+import { WASMSimulator } from "@aztec/simulator/client";
 
 process.env = Object.keys(import.meta.env).reduce((acc, key) => {
   acc[key.replace("VITE_", "")] = import.meta.env[key];
@@ -39,25 +38,11 @@ export class PrivateEnv {
     config.dataDirectory = "pxe";
     config.proverEnabled = true;
     const aztecNode = await createAztecNodeClient(this.nodeURL);
-    const proofCreator = new BBWASMLazyPrivateKernelProver(16);
-    this.pxe = await this.createPXEService(aztecNode, config, proofCreator);
-    const encryptionPrivateKey = deriveMasterIncomingViewingSecretKey(
-      this.secretKey,
+    const simulationProvider = new WASMSimulator();
+    const proofCreator = new BBWASMLazyPrivateKernelProver(
+      simulationProvider,
+      16,
     );
-    this.accountContract = new SchnorrAccountContract(encryptionPrivateKey);
-    this.account = new AccountManager(
-      this.pxe,
-      this.secretKey,
-      this.accountContract,
-    );
-    await this.account.deploy().wait();
-  }
-
-  async createPXEService(
-    aztecNode: AztecNode,
-    config: PXEServiceConfig,
-    proofCreator?: PrivateKernelProver,
-  ) {
     const l1Contracts = await aztecNode.getL1ContractAddresses();
     const configWithContracts = {
       ...config,
@@ -75,16 +60,26 @@ export class PrivateEnv {
     const db = await KVPxeDatabase.create(store);
     const tips = new L2TipsStore(store, "pxe");
 
-    const pxe = new PXEService(
+    this.pxe = new PXEService(
       keyStore,
       aztecNode,
       db,
       tips,
       proofCreator,
+      simulationProvider,
       config,
     );
-    await pxe.init();
-    return pxe;
+    await this.pxe.init();
+    const encryptionPrivateKey = deriveMasterIncomingViewingSecretKey(
+      this.secretKey,
+    );
+    this.accountContract = new SchnorrAccountContract(encryptionPrivateKey);
+    this.account = new AccountManager(
+      this.pxe,
+      this.secretKey,
+      this.accountContract,
+    );
+    await this.account.deploy().wait();
   }
 
   async getWallet() {

diff --git a/boxes/boxes/vite/vite.config.ts b/boxes/boxes/vite/vite.config.ts
@@ -32,6 +32,8 @@ export default defineConfig({
       allow: [
         searchForWorkspaceRoot(process.cwd()),
         "../../../yarn-project/noir-protocol-circuits-types/artifacts",
+        "../../../noir/packages/noirc_abi/web",
+        "../../../noir/packages/acvm_js/web",
       ],
     },
   },
@@ -51,7 +53,4 @@ export default defineConfig({
       },
     },
   },
-  optimizeDeps: {
-    exclude: ["@noir-lang/acvm_js", "@noir-lang/noirc_abi", "@aztec/bb-prover"],
-  },
 });
diff --git a/boxes/yarn.lock b/boxes/yarn.lock
@@ -139,6 +139,12 @@ __metadata:
   languageName: unknown
   linkType: soft
 
+"@aztec/simulator@link:../../../yarn-project/simulator::locator=vite%40workspace%3Aboxes%2Fvite":
+  version: 0.0.0-use.local
+  resolution: "@aztec/simulator@link:../../../yarn-project/simulator::locator=vite%40workspace%3Aboxes%2Fvite"
+  languageName: node
+  linkType: soft
+
 "@aztec/types@link:../yarn-project/types::locator=aztec-app%40workspace%3A.":
   version: 0.0.0-use.local
   resolution: "@aztec/types@link:../yarn-project/types::locator=aztec-app%40workspace%3A."
@@ -1664,18 +1670,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@noir-lang/acvm_js@link:../../../noir/packages/acvm_js::locator=vite%40workspace%3Aboxes%2Fvite":
-  version: 0.0.0-use.local
-  resolution: "@noir-lang/acvm_js@link:../../../noir/packages/acvm_js::locator=vite%40workspace%3Aboxes%2Fvite"
-  languageName: node
-  linkType: soft
-
-"@noir-lang/noirc_abi@link:../../../noir/packages/noirc_abi::locator=vite%40workspace%3Aboxes%2Fvite":
-  version: 0.0.0-use.local
-  resolution: "@noir-lang/noirc_abi@link:../../../noir/packages/noirc_abi::locator=vite%40workspace%3Aboxes%2Fvite"
-  languageName: node
-  linkType: soft
-
 "@nolyfill/is-core-module@npm:1.0.39":
   version: 1.0.39
   resolution: "@nolyfill/is-core-module@npm:1.0.39"
@@ -12162,13 +12156,11 @@ __metadata:
     "@aztec/key-store": "link:../../../yarn-project/key-store"
     "@aztec/kv-store": "portal:../../../yarn-project/kv-store"
     "@aztec/pxe": "link:../../../yarn-project/pxe"
+    "@aztec/simulator": "link:../../../yarn-project/simulator"
     "@eslint/js": "npm:^9.13.0"
-    "@noir-lang/acvm_js": "link:../../../noir/packages/acvm_js"
-    "@noir-lang/noirc_abi": "link:../../../noir/packages/noirc_abi"
     "@types/react": "npm:^18.3.12"
     "@types/react-dom": "npm:^18.3.1"
     "@vitejs/plugin-react-swc": "npm:^3.7.2"
-    buffer: "npm:^6.0.3"
     eslint: "npm:^9.13.0"
     eslint-plugin-react-hooks: "npm:^5.1.0"
     eslint-plugin-react-refresh: "npm:^0.4.16"

diff --git a/yarn-project/aztec-node/src/aztec-node/server.ts b/yarn-project/aztec-node/src/aztec-node/server.ts
@@ -73,7 +73,7 @@ import {
   createValidatorForAcceptingTxs,
   getDefaultAllowedSetupFunctions,
 } from '@aztec/sequencer-client';
-import { PublicProcessorFactory } from '@aztec/simulator';
+import { PublicProcessorFactory } from '@aztec/simulator/server';
 import { Attributes, type TelemetryClient, type Traceable, type Tracer, trackSpan } from '@aztec/telemetry-client';
 import { NoopTelemetryClient } from '@aztec/telemetry-client/noop';
 import { createValidatorClient } from '@aztec/validator-client';

diff --git a/yarn-project/bb-prover/src/prover/bb_native_private_kernel_prover.ts b/yarn-project/bb-prover/src/prover/bb_native_private_kernel_prover.ts
@@ -2,6 +2,7 @@ import { type ClientIvcProof } from '@aztec/circuits.js';
 import { runInDirectory } from '@aztec/foundation/fs';
 import { type Logger, createLogger } from '@aztec/foundation/log';
 import { BundleArtifactProvider } from '@aztec/noir-protocol-circuits-types/client/bundle';
+import { type SimulationProvider } from '@aztec/simulator/server';
 
 import { encode } from '@msgpack/msgpack';
 import { serializeWitness } from '@noir-lang/noirc_abi';
@@ -22,14 +23,21 @@ export class BBNativePrivateKernelProver extends BBPrivateKernelProver {
     private bbBinaryPath: string,
     private bbWorkingDirectory: string,
     private skipCleanup: boolean,
+    protected override simulationProvider: SimulationProvider,
     protected override log = createLogger('bb-prover:native'),
   ) {
-    super(new BundleArtifactProvider(), log);
+    super(new BundleArtifactProvider(), simulationProvider, log);
   }
 
-  public static async new(config: BBConfig, log?: Logger) {
+  public static async new(config: BBConfig, simulationProvider: SimulationProvider, log?: Logger) {
     await fs.mkdir(config.bbWorkingDirectory, { recursive: true });
-    return new BBNativePrivateKernelProver(config.bbBinaryPath, config.bbWorkingDirectory, !!config.bbSkipCleanup, log);
+    return new BBNativePrivateKernelProver(
+      config.bbBinaryPath,
+      config.bbWorkingDirectory,
+      !!config.bbSkipCleanup,
+      simulationProvider,
+      log,
+    );
   }
 
   private async _createClientIvcProof(

diff --git a/yarn-project/bb-prover/src/prover/bb_private_kernel_prover.ts b/yarn-project/bb-prover/src/prover/bb_private_kernel_prover.ts
@@ -27,17 +27,19 @@ import {
 } from '@aztec/noir-protocol-circuits-types/client';
 import { type ArtifactProvider, type ClientProtocolArtifact } from '@aztec/noir-protocol-circuits-types/types';
 import { ClientCircuitVks } from '@aztec/noir-protocol-circuits-types/vks';
-import { WASMSimulator } from '@aztec/simulator/client';
+import { type SimulationProvider } from '@aztec/simulator/client';
 import { type NoirCompiledCircuit } from '@aztec/types/noir';
 
 import { type Abi, type WitnessMap } from '@noir-lang/types';
 
 import { mapProtocolArtifactNameToCircuitName } from '../stats.js';
 
 export abstract class BBPrivateKernelProver implements PrivateKernelProver {
-  protected simulator = new WASMSimulator();
-
-  constructor(protected artifactProvider: ArtifactProvider, protected log = createLogger('bb-prover')) {}
+  constructor(
+    protected artifactProvider: ArtifactProvider,
+    protected simulationProvider: SimulationProvider,
+    protected log = createLogger('bb-prover'),
+  ) {}
 
   public async generateInitOutput(
     inputs: PrivateKernelInitCircuitPrivateInputs,
@@ -164,7 +166,7 @@ export abstract class BBPrivateKernelProver implements PrivateKernelProver {
     const witnessMap = convertInputs(inputs, compiledCircuit.abi);
 
     const timer = new Timer();
-    const outputWitness = await this.simulator.simulateCircuit(witnessMap, compiledCircuit);
+    const outputWitness = await this.simulationProvider.executeProtocolCircuit(witnessMap, compiledCircuit);
     const output = convertOutputs(outputWitness, compiledCircuit.abi);
 
     this.log.debug(`Simulated ${circuitType}`, {
@@ -194,7 +196,7 @@ export abstract class BBPrivateKernelProver implements PrivateKernelProver {
 
     const witnessMap = convertInputs(inputs, compiledCircuit.abi);
     const timer = new Timer();
-    const outputWitness = await this.simulator.simulateCircuit(witnessMap, compiledCircuit);
+    const outputWitness = await this.simulationProvider.executeProtocolCircuit(witnessMap, compiledCircuit);
     const output = convertOutputs(outputWitness, compiledCircuit.abi);
 
     this.log.debug(`Generated witness for ${circuitType}`, {

diff --git a/yarn-project/bb-prover/src/prover/bb_prover.ts b/yarn-project/bb-prover/src/prover/bb_prover.ts
@@ -69,7 +69,7 @@ import {
   convertSingleTxBlockRootRollupInputsToWitnessMap,
   convertSingleTxBlockRootRollupOutputsFromWitnessMap,
 } from '@aztec/noir-protocol-circuits-types/server';
-import { NativeACVMSimulator } from '@aztec/simulator';
+import { NativeACVMSimulator } from '@aztec/simulator/server';
 import { Attributes, type TelemetryClient, trackSpan } from '@aztec/telemetry-client';
 
 import { type WitnessMap } from '@noir-lang/types';
@@ -427,7 +427,7 @@ export class BBNativeRollupProver implements ServerCircuitProver {
 
     const inputWitness = convertInput(input);
     const timer = new Timer();
-    const outputWitness = await simulator.simulateCircuit(inputWitness, artifact);
+    const outputWitness = await simulator.executeProtocolCircuit(inputWitness, artifact);
     const output = convertOutput(outputWitness);
 
     const circuitName = mapProtocolArtifactNameToCircuitName(circuitType);

diff --git a/yarn-project/bb-prover/src/test/test_avm.ts b/yarn-project/bb-prover/src/test/test_avm.ts
@@ -28,7 +28,7 @@ import {
 } from '@aztec/circuits.js';
 import { computeVarArgsHash } from '@aztec/circuits.js/hash';
 import { padArrayEnd } from '@aztec/foundation/collection';
-import { type PublicFunctionCallResult } from '@aztec/simulator';
+import { type PublicFunctionCallResult } from '@aztec/simulator/server';
 
 // TODO: pub somewhere more usable - copied from abstract phase manager
 export function getPublicInputs(result: PublicFunctionCallResult): PublicCircuitPublicInputs {

diff --git a/yarn-project/bb-prover/src/test/test_circuit_prover.ts b/yarn-project/bb-prover/src/test/test_circuit_prover.ts
@@ -63,7 +63,7 @@ import {
   convertSimulatedSingleTxBlockRootRollupOutputsFromWitnessMap,
 } from '@aztec/noir-protocol-circuits-types/server';
 import { ProtocolCircuitVks } from '@aztec/noir-protocol-circuits-types/vks';
-import { type SimulationProvider, WASMSimulatorWithBlobs, emitCircuitSimulationStats } from '@aztec/simulator';
+import { type SimulationProvider, WASMSimulatorWithBlobs, emitCircuitSimulationStats } from '@aztec/simulator/server';
 import { type TelemetryClient, trackSpan } from '@aztec/telemetry-client';
 
 import { type WitnessMap } from '@noir-lang/types';
@@ -324,7 +324,10 @@ export class TestCircuitProver implements ServerCircuitProver {
       // the blob operations with an oracle. Appears to be no way to provide nativeACVM with a foreign call hander.
       simulationProvider = this.wasmSimulator;
     }
-    const witness = await simulationProvider.simulateCircuit(witnessMap, SimulatedServerCircuitArtifacts[artifactName]);
+    const witness = await simulationProvider.executeProtocolCircuit(
+      witnessMap,
+      SimulatedServerCircuitArtifacts[artifactName],
+    );
 
     const result = convertOutput(witness);
 

diff --git a/yarn-project/bb-prover/src/wasm/bb_wasm_private_kernel_prover.ts b/yarn-project/bb-prover/src/wasm/bb_wasm_private_kernel_prover.ts
@@ -3,6 +3,7 @@ import { ClientIvcProof } from '@aztec/circuits.js';
 import { createLogger } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
 import { type ArtifactProvider } from '@aztec/noir-protocol-circuits-types/types';
+import { type SimulationProvider } from '@aztec/simulator/client';
 
 import { serializeWitness } from '@noir-lang/noirc_abi';
 import { type WitnessMap } from '@noir-lang/types';
@@ -13,10 +14,11 @@ import { BBPrivateKernelProver } from '../prover/bb_private_kernel_prover.js';
 export abstract class BBWASMPrivateKernelProver extends BBPrivateKernelProver {
   constructor(
     protected override artifactProvider: ArtifactProvider,
+    protected override simulationProvider: SimulationProvider,
     private threads: number = 1,
     protected override log = createLogger('bb-prover:wasm'),
   ) {
-    super(artifactProvider, log);
+    super(artifactProvider, simulationProvider, log);
   }
 
   public override async createClientIvcProof(acirs: Buffer[], witnessStack: WitnessMap[]): Promise<ClientIvcProof> {

diff --git a/yarn-project/bb-prover/src/wasm/bundle.ts b/yarn-project/bb-prover/src/wasm/bundle.ts
@@ -1,10 +1,11 @@
 import { createLogger } from '@aztec/foundation/log';
 import { BundleArtifactProvider } from '@aztec/noir-protocol-circuits-types/client/bundle';
+import { type SimulationProvider } from '@aztec/simulator/client';
 
 import { BBWASMPrivateKernelProver } from './bb_wasm_private_kernel_prover.js';
 
 export class BBWASMBundlePrivateKernelProver extends BBWASMPrivateKernelProver {
-  constructor(threads = 1, log = createLogger('bb-prover:wasm:bundle')) {
-    super(new BundleArtifactProvider(), threads, log);
+  constructor(simulationProvider: SimulationProvider, threads = 1, log = createLogger('bb-prover:wasm:bundle')) {
+    super(new BundleArtifactProvider(), simulationProvider, threads, log);
   }
 }
diff --git a/yarn-project/bb-prover/src/wasm/lazy.ts b/yarn-project/bb-prover/src/wasm/lazy.ts
@@ -1,10 +1,11 @@
 import { createLogger } from '@aztec/foundation/log';
 import { LazyArtifactProvider } from '@aztec/noir-protocol-circuits-types/client/lazy';
+import { type SimulationProvider } from '@aztec/simulator/client';
 
 import { BBWASMPrivateKernelProver } from './bb_wasm_private_kernel_prover.js';
 
 export class BBWASMLazyPrivateKernelProver extends BBWASMPrivateKernelProver {
-  constructor(threads = 1, log = createLogger('bb-prover:wasm:lazy')) {
-    super(new LazyArtifactProvider(), threads, log);
+  constructor(simulationProvider: SimulationProvider, threads = 1, log = createLogger('bb-prover:wasm:lazy')) {
+    super(new LazyArtifactProvider(), simulationProvider, threads, log);
   }
 }
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
@@ -31,7 +31,12 @@ import { TestContract } from '@aztec/noir-contracts.js/Test';
 import { TokenContract } from '@aztec/noir-contracts.js/Token';
 import { type SequencerClient, SequencerState } from '@aztec/sequencer-client';
 import { type TestSequencerClient } from '@aztec/sequencer-client/test';
-import { PublicProcessorFactory, type PublicTxResult, PublicTxSimulator, type WorldStateDB } from '@aztec/simulator';
+import {
+  PublicProcessorFactory,
+  type PublicTxResult,
+  PublicTxSimulator,
+  type WorldStateDB,
+} from '@aztec/simulator/server';
 import { type TelemetryClient } from '@aztec/telemetry-client';
 import { NoopTelemetryClient } from '@aztec/telemetry-client/noop';
 

diff --git a/yarn-project/end-to-end/src/e2e_crowdfunding_and_claim.test.ts b/yarn-project/end-to-end/src/e2e_crowdfunding_and_claim.test.ts
@@ -355,7 +355,7 @@ describe('e2e_crowdfunding_and_claim', () => {
     donorWallets[1].setScopes([donorWallets[1].getAddress(), crowdfundingContract.address]);
 
     await expect(donorWallets[1].simulateTx(request, true, operatorWallet.getAddress())).rejects.toThrow(
-      'Assertion failed',
+      'Circuit execution failed: Users cannot set msg_sender in first call',
     );
   });