chore: @aztec/simulator reorg (#12361)

As part of a larger PXE refactor, moved components around
`@aztec/simulator` to better identify responsibilities and which code
goes where.

* `public` now contains all public code (including AVM simulator), but
it's not 100% of the `server` bundle. Same thing for the newly created
`private` folder.
* `/client` bundle contains MOST of `private` code, except for the
native and "with blobs" versions of `acvm` simulator. It also has all
the common code
* `/server` bundle contains all of `public` code, plus the native and
"with blobs" versions of the `acvm` simulator. Like client, it has all
the common code.

---------

Co-authored-by: esau <[email protected]>

Author: Thunkar

docs/docs/aztec/smart_contracts/functions/attributes.md

@@ -1,5 +1,5 @@
 import { PublicTxSimulationTester, type TestEnqueuedCall } from '@aztec/simulator/public/fixtures';
-import { WorldStateDB } from '@aztec/simulator/server';
+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';
@@ -10,7 +10,6 @@ import fs from 'node:fs/promises';
 import { tmpdir } from 'node:os';
 import path from 'path';
 
-import { SimpleContractDataSource } from '../../../simulator/src/avm/fixtures/simple_contract_data_source.js';
 import {
   type BBResult,
   type BBSuccess,

yarn-project/bb-prover/src/avm_proving_tests/avm_proving_tester.ts

@@ -10,12 +10,8 @@ import { Fr } from '@aztec/foundation/fields';
 import { createLogger } from '@aztec/foundation/log';
 import { BufferReader } from '@aztec/foundation/serialize';
 import type { KeyStore } from '@aztec/key-store';
-import {
-  type AcirSimulator,
-  type DBOracle,
-  MessageLoadOracleInputs,
-  type SimulationProvider,
-} from '@aztec/simulator/client';
+import type { AcirSimulator, DBOracle, SimulationProvider } from '@aztec/simulator/client';
+import { MessageLoadOracleInputs } from '@aztec/simulator/client';
 import {
   type FunctionArtifact,
   FunctionCall,

yarn-project/pxe/src/simulator_oracle/index.ts

@@ -3,9 +3,8 @@
   "version": "0.1.0",
   "type": "module",
   "exports": {
-    "./common": "./dest/common.js",
     "./server": "./dest/server.js",
-    "./client": "./dest/client/index.js",
+    "./client": "./dest/client.js",
     "./public/fixtures": "./dest/public/fixtures/index.js"
   },
   "typedocOptions": {

yarn-project/simulator/package.json

@@ -0,0 +1,4 @@
+export * from './private/index.js';
+export { WASMSimulator } from './private/providers/acvm_wasm.js';
+export { type SimulationProvider } from './private/providers/simulation_provider.js';
+export * from './common/index.js';

yarn-project/simulator/src/client.ts

@@ -5,7 +5,7 @@ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { ContractInstanceWithAddress } from '@aztec/stdlib/contract';
 import type { NullifierMembershipWitness } from '@aztec/stdlib/trees';
 
-import type { MessageLoadOracleInputs } from '../common/message_load_oracle_inputs.js';
+import type { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
 
 /**
  * Database interface for providing access to public state.

yarn-project/simulator/src/client/index.ts

@@ -1,2 +1,3 @@
-export * from './hashed_values_cache.js';
 export * from './errors.js';
+export * from './stats/index.js';
+export * from './message_load_oracle_inputs.js';

yarn-project/simulator/src/common.ts

@@ -9,7 +9,7 @@ import {
   executeCircuitWithReturnWitness,
 } from '@noir-lang/acvm_js';
 
-import { resolveOpcodeLocations, traverseCauseChain } from '../common/errors.js';
+import { resolveOpcodeLocations, traverseCauseChain } from '../../common/errors.js';
 import type { ACVMWitness } from './acvm_types.js';
 import type { ORACLE_NAMES } from './oracle/index.js';
 

yarn-project/simulator/src/public/db_interfaces.ts renamed to yarn-project/simulator/src/common/db_interfaces.ts

@@ -9,7 +9,7 @@ import type { Note, NoteStatus } from '@aztec/stdlib/note';
 import { type MerkleTreeId, type NullifierMembershipWitness, PublicDataWitness } from '@aztec/stdlib/trees';
 import type { BlockHeader } from '@aztec/stdlib/tx';
 
-import type { MessageLoadOracleInputs } from '../../common/message_load_oracle_inputs.js';
+import type { MessageLoadOracleInputs } from '../../../common/message_load_oracle_inputs.js';
 
 /**
  * Information about a note needed during execution.

yarn-project/simulator/src/common/index.ts

@@ -27,13 +27,13 @@ import {
   type TxContext,
 } from '@aztec/stdlib/tx';
 
-import { type NoteData, toACVMWitness } from '../acvm/index.js';
-import type { HashedValuesCache } from '../common/hashed_values_cache.js';
-import type { SimulationProvider } from '../server.js';
+import { type NoteData, toACVMWitness } from './acvm/index.js';
 import type { DBOracle } from './db_oracle.js';
 import type { ExecutionNoteCache } from './execution_note_cache.js';
+import type { HashedValuesCache } from './hashed_values_cache.js';
 import { pickNotes } from './pick_notes.js';
 import { executePrivateFunction, verifyCurrentClassId } from './private_execution.js';
+import type { SimulationProvider } from './providers/simulation_provider.js';
 import { ViewDataOracle } from './view_data_oracle.js';
 
 /**

yarn-project/simulator/src/stats/index.ts renamed to yarn-project/simulator/src/common/stats/index.ts

@@ -9,8 +9,8 @@ import type { NoteStatus } from '@aztec/stdlib/note';
 import { type MerkleTreeId, type NullifierMembershipWitness, PublicDataWitness } from '@aztec/stdlib/trees';
 import type { BlockHeader } from '@aztec/stdlib/tx';
 
-import type { NoteData } from '../acvm/index.js';
-import type { CommitmentsDB } from '../public/db_interfaces.js';
+import type { CommitmentsDB } from '../common/db_interfaces.js';
+import type { NoteData } from './acvm/index.js';
 
 /**
  * Error thrown when a contract is not found in the database.

yarn-project/simulator/src/stats/stats.ts renamed to yarn-project/simulator/src/common/stats/stats.ts

@@ -2,7 +2,7 @@ import { Fr } from '@aztec/foundation/fields';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { computeNoteHashNonce, computeUniqueNoteHash, siloNoteHash, siloNullifier } from '@aztec/stdlib/hash';
 
-import type { NoteData } from '../acvm/index.js';
+import type { NoteData } from './acvm/index.js';
 
 interface PendingNote {
   note: NoteData;

yarn-project/simulator/src/acvm/acvm.ts renamed to yarn-project/simulator/src/private/acvm/acvm.ts

@@ -0,0 +1,12 @@
+export { AcirSimulator } from './simulator.js';
+export { ViewDataOracle } from './view_data_oracle.js';
+export { type DBOracle, ContractClassNotFoundError, ContractNotFoundError } from './db_oracle.js';
+export * from './pick_notes.js';
+export { ExecutionNoteCache } from './execution_note_cache.js';
+export { extractPrivateCircuitPublicInputs, readCurrentClassId } from './private_execution.js';
+export { witnessMapToFields } from './acvm/deserialize.js';
+export { toACVMWitness } from './acvm/serialize.js';
+export { extractCallStack } from './acvm/acvm.js';
+export { type NoteData, TypedOracle } from './acvm/oracle/typed_oracle.js';
+export { Oracle } from './acvm/oracle/oracle.js';
+export { HashedValuesCache } from './hashed_values_cache.js';

yarn-project/simulator/src/acvm/acvm_types.ts renamed to yarn-project/simulator/src/private/acvm/acvm_types.ts

@@ -70,9 +70,9 @@ import { Matcher, type MatcherCreator, type MockProxy, mock } from 'jest-mock-ex
 import { toFunctionSelector } from 'viem';
 
 import { MessageLoadOracleInputs } from '../common/message_load_oracle_inputs.js';
-import { WASMSimulator } from '../providers/acvm_wasm.js';
 import { buildL1ToL2Message } from '../test/utils.js';
 import type { DBOracle } from './db_oracle.js';
+import { WASMSimulator } from './providers/acvm_wasm.js';
 import { AcirSimulator } from './simulator.js';
 
 jest.setTimeout(60_000);

yarn-project/simulator/src/acvm/deserialize.ts renamed to yarn-project/simulator/src/private/acvm/deserialize.ts

@@ -12,11 +12,11 @@ import { SharedMutableValues, SharedMutableValuesWithHash } from '@aztec/stdlib/
 import type { CircuitWitnessGenerationStats } from '@aztec/stdlib/stats';
 import { PrivateCallExecutionResult } from '@aztec/stdlib/tx';
 
-import { fromACVMField, witnessMapToFields } from '../acvm/deserialize.js';
-import { type ACVMWitness, Oracle, extractCallStack } from '../acvm/index.js';
 import { ExecutionError, resolveAssertionMessageFromError } from '../common/errors.js';
-import type { SimulationProvider } from '../server.js';
+import { fromACVMField, witnessMapToFields } from './acvm/deserialize.js';
+import { type ACVMWitness, Oracle, extractCallStack } from './acvm/index.js';
 import type { ClientExecutionContext } from './client_execution_context.js';
+import type { SimulationProvider } from './providers/simulation_provider.js';
 
 /**
  * Execute a private function and return the execution result.

yarn-project/simulator/src/acvm/index.ts renamed to yarn-project/simulator/src/private/acvm/index.ts

@@ -9,7 +9,7 @@ import { promises as fs } from 'fs';
 
 import type { ACIRCallback, ACIRExecutionResult } from '../acvm/acvm.js';
 import type { ACVMWitness } from '../acvm/acvm_types.js';
-import type { SimulationProvider } from '../common/simulation_provider.js';
+import type { SimulationProvider } from './simulation_provider.js';
 
 const logger = createLogger('simulator:acvm-native');
 

yarn-project/simulator/src/acvm/oracle/index.ts renamed to yarn-project/simulator/src/private/acvm/oracle/index.ts

@@ -8,7 +8,7 @@ import type { WitnessMap } from '@noir-lang/types';
 
 import { type ACIRCallback, acvm } from '../acvm/acvm.js';
 import type { ACVMWitness } from '../acvm/acvm_types.js';
-import { type SimulationProvider, parseErrorPayload } from '../common/simulation_provider.js';
+import { type SimulationProvider, parseErrorPayload } from './simulation_provider.js';
 
 export class WASMSimulator implements SimulationProvider {
   constructor(protected log = createLogger('wasm-simulator')) {}

yarn-project/simulator/src/acvm/oracle/oracle.ts renamed to yarn-project/simulator/src/private/acvm/oracle/oracle.ts

@@ -6,7 +6,7 @@ import type { WitnessMap } from '@noir-lang/types';
 
 import type { ACIRCallback, ACIRExecutionResult } from '../acvm/acvm.js';
 import type { ACVMWitness } from '../acvm/acvm_types.js';
-import { type SimulationProvider, parseErrorPayload } from '../common/simulation_provider.js';
+import { type SimulationProvider, parseErrorPayload } from './simulation_provider.js';
 
 /**
  * A simulation provider that uses the WASM simulator with the ability to handle blobs via the foreign call handler.

yarn-project/simulator/src/acvm/oracle/typed_oracle.ts renamed to yarn-project/simulator/src/private/acvm/oracle/typed_oracle.ts

@@ -2,9 +2,9 @@ import { type Logger, createLogger } from '@aztec/foundation/log';
 
 import { promises as fs } from 'fs';
 
-import type { SimulationProvider } from '../common/simulation_provider.js';
 import { NativeACVMSimulator } from './acvm_native.js';
 import { WASMSimulator } from './acvm_wasm.js';
+import type { SimulationProvider } from './simulation_provider.js';
 
 export type SimulationProviderConfig = {
   acvmBinaryPath?: string;

yarn-project/simulator/src/acvm/serialize.ts renamed to yarn-project/simulator/src/private/acvm/serialize.ts

@@ -7,12 +7,12 @@ import type { AztecNode } from '@aztec/stdlib/interfaces/client';
 import { CallContext, PrivateExecutionResult, TxExecutionRequest } from '@aztec/stdlib/tx';
 
 import { createSimulationError } from '../common/errors.js';
-import { HashedValuesCache } from '../common/hashed_values_cache.js';
-import type { SimulationProvider } from '../common/simulation_provider.js';
 import { ClientExecutionContext } from './client_execution_context.js';
 import type { DBOracle } from './db_oracle.js';
 import { ExecutionNoteCache } from './execution_note_cache.js';
+import { HashedValuesCache } from './hashed_values_cache.js';
 import { executePrivateFunction, verifyCurrentClassId } from './private_execution.js';
+import type { SimulationProvider } from './providers/simulation_provider.js';
 import { executeUnconstrainedFunction } from './unconstrained_execution.js';
 import { ViewDataOracle } from './view_data_oracle.js';
 

yarn-project/simulator/src/client/client_execution_context.ts renamed to yarn-project/simulator/src/private/client_execution_context.ts

@@ -10,8 +10,8 @@ import { BlockHeader } from '@aztec/stdlib/tx';
 
 import { mock } from 'jest-mock-extended';
 
-import { WASMSimulator } from '../providers/acvm_wasm.js';
 import type { DBOracle } from './db_oracle.js';
+import { WASMSimulator } from './providers/acvm_wasm.js';
 import { AcirSimulator } from './simulator.js';
 
 describe('Unconstrained Execution test suite', () => {

yarn-project/simulator/src/client/db_oracle.ts renamed to yarn-project/simulator/src/private/db_oracle.ts

@@ -3,10 +3,10 @@ import { createLogger } from '@aztec/foundation/log';
 import { type AbiDecoded, type FunctionArtifact, type FunctionSelector, decodeFromAbi } from '@aztec/stdlib/abi';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 
-import { witnessMapToFields } from '../acvm/deserialize.js';
-import { Oracle, extractCallStack, toACVMWitness } from '../acvm/index.js';
 import { ExecutionError, resolveAssertionMessageFromError } from '../common/errors.js';
-import type { SimulationProvider } from '../server.js';
+import { witnessMapToFields } from './acvm/deserialize.js';
+import { Oracle, extractCallStack, toACVMWitness } from './acvm/index.js';
+import type { SimulationProvider } from './providers/simulation_provider.js';
 import type { ViewDataOracle } from './view_data_oracle.js';
 
 // docs:start:execute_unconstrained_function

yarn-project/simulator/src/client/execution_note_cache.ts renamed to yarn-project/simulator/src/private/execution_note_cache.ts

@@ -12,7 +12,7 @@ import type { NoteStatus } from '@aztec/stdlib/note';
 import { type MerkleTreeId, type NullifierMembershipWitness, PublicDataWitness } from '@aztec/stdlib/trees';
 import type { BlockHeader, Capsule } from '@aztec/stdlib/tx';
 
-import { type NoteData, TypedOracle } from '../acvm/index.js';
+import { type NoteData, TypedOracle } from './acvm/index.js';
 import type { DBOracle } from './db_oracle.js';
 import { pickNotes } from './pick_notes.js';
 

yarn-project/simulator/src/common/hashed_values_cache.ts renamed to yarn-project/simulator/src/private/hashed_values_cache.ts

@@ -4,7 +4,7 @@ import { Gas } from '@aztec/stdlib/gas';
 
 import { inspect } from 'util';
 
-import { createSimulationError } from '../common/errors.js';
+import { createSimulationError } from '../../common/errors.js';
 import type { Gas as AvmGas } from './avm_gas.js';
 import type { AvmRevertReason } from './errors.js';
 

yarn-project/simulator/src/private/index.ts

@@ -32,9 +32,9 @@ import { NativeWorldStateService } from '@aztec/world-state';
 import { randomInt } from 'crypto';
 import { mock } from 'jest-mock-extended';
 
-import { WorldStateDB } from '../public/public_db_sources.js';
-import { SideEffectTrace } from '../public/side_effect_trace.js';
-import type { PublicSideEffectTraceInterface } from '../public/side_effect_trace_interface.js';
+import { SideEffectTrace } from '../../public/side_effect_trace.js';
+import type { PublicSideEffectTraceInterface } from '../../public/side_effect_trace_interface.js';
+import { WorldStateDB } from '../public_db_sources.js';
 import type { AvmContext } from './avm_context.js';
 import type { AvmExecutionEnvironment } from './avm_execution_environment.js';
 import { type MemoryValue, TypeTag, type Uint8, type Uint64 } from './avm_memory_types.js';

yarn-project/simulator/src/client/pick_notes.test.ts renamed to yarn-project/simulator/src/private/pick_notes.test.ts

@@ -6,7 +6,7 @@ import type { GlobalVariables } from '@aztec/stdlib/tx';
 
 import { strict as assert } from 'assert';
 
-import { SideEffectLimitReachedError } from '../public/side_effect_errors.js';
+import { SideEffectLimitReachedError } from '../side_effect_errors.js';
 import { AvmContext } from './avm_context.js';
 import { AvmContractCallResult } from './avm_contract_call_result.js';
 import { AvmExecutionEnvironment } from './avm_execution_environment.js';

yarn-project/simulator/src/client/pick_notes.ts renamed to yarn-project/simulator/src/private/pick_notes.ts

@@ -2,7 +2,7 @@ import type { Fr, Point } from '@aztec/foundation/fields';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { FailingFunction, NoirCallStack } from '@aztec/stdlib/errors';
 
-import { ExecutionError } from '../common/errors.js';
+import { ExecutionError } from '../../common/errors.js';
 import type { AvmContext } from './avm_context.js';
 
 /**

yarn-project/simulator/src/client/private_execution.test.ts renamed to yarn-project/simulator/src/private/private_execution.test.ts

@@ -6,6 +6,7 @@ import type { MerkleTreeWriteOperations } from '@aztec/stdlib/interfaces/server'
 import { GlobalVariables } from '@aztec/stdlib/tx';
 import { NativeWorldStateService } from '@aztec/world-state';
 
+import { SideEffectTrace } from '../../../public/side_effect_trace.js';
 import type { AvmContractCallResult } from '../../avm/avm_contract_call_result.js';
 import {
   getContractFunctionArtifact,
@@ -14,9 +15,9 @@ import {
   initExecutionEnvironment,
   resolveContractAssertionMessage,
 } from '../../avm/fixtures/index.js';
-import { WorldStateDB } from '../../public/public_db_sources.js';
-import { SideEffectTrace } from '../../public/side_effect_trace.js';
-import { AvmPersistableStateManager, AvmSimulator } from '../../server.js';
+import { AvmPersistableStateManager } from '../../avm/journal/journal.js';
+import { WorldStateDB } from '../../public_db_sources.js';
+import { AvmSimulator } from '../avm_simulator.js';
 import { BaseAvmSimulationTester } from './base_avm_simulation_tester.js';
 import { SimpleContractDataSource } from './simple_contract_data_source.js';
 

yarn-project/simulator/src/client/private_execution.ts renamed to yarn-project/simulator/src/private/private_execution.ts

@@ -14,13 +14,14 @@ import { strict as assert } from 'assert';
 import { mock } from 'jest-mock-extended';
 import merge from 'lodash.merge';
 
-import { resolveAssertionMessageFromRevertData, traverseCauseChain } from '../../common.js';
-import type { PublicSideEffectTraceInterface } from '../../public/side_effect_trace_interface.js';
-import { AvmSimulator, type WorldStateDB } from '../../server.js';
+import { resolveAssertionMessageFromRevertData, traverseCauseChain } from '../../../common/index.js';
+import type { WorldStateDB } from '../../public_db_sources.js';
+import type { PublicSideEffectTraceInterface } from '../../side_effect_trace_interface.js';
 import { AvmContext } from '../avm_context.js';
 import { AvmExecutionEnvironment } from '../avm_execution_environment.js';
 import { AvmMachineState } from '../avm_machine_state.js';
 import { Field, Uint8, Uint32, Uint64 } from '../avm_memory_types.js';
+import { AvmSimulator } from '../avm_simulator.js';
 import type { AvmRevertReason } from '../errors.js';
 import { AvmPersistableStateManager } from '../journal/journal.js';
 import { NullifierManager } from '../journal/nullifiers.js';

yarn-project/simulator/src/providers/acvm_native.ts renamed to yarn-project/simulator/src/private/providers/acvm_native.ts

@@ -6,8 +6,8 @@ import { makeContractClassPublic } from '@aztec/stdlib/testing';
 
 import { mock } from 'jest-mock-extended';
 
-import type { WorldStateDB } from '../../public/public_db_sources.js';
-import type { PublicSideEffectTraceInterface } from '../../public/side_effect_trace_interface.js';
+import type { PublicSideEffectTraceInterface } from '../../../public/side_effect_trace_interface.js';
+import type { WorldStateDB } from '../../public_db_sources.js';
 import { initPersistableStateManager } from '../fixtures/index.js';
 import {
   mockGetBytecode,

yarn-project/simulator/src/providers/acvm_wasm.ts renamed to yarn-project/simulator/src/private/providers/acvm_wasm.ts

@@ -30,9 +30,9 @@ import { MerkleTreeId, NullifierLeafPreimage, PublicDataTreeLeafPreimage } from
 import { strict as assert } from 'assert';
 import cloneDeep from 'lodash.clonedeep';
 
-import { getPublicFunctionDebugName } from '../../common/debug_fn_name.js';
-import type { WorldStateDB } from '../../public/public_db_sources.js';
-import type { PublicSideEffectTraceInterface } from '../../public/side_effect_trace_interface.js';
+import { getPublicFunctionDebugName } from '../../../common/debug_fn_name.js';
+import type { WorldStateDB } from '../../../public/public_db_sources.js';
+import type { PublicSideEffectTraceInterface } from '../../side_effect_trace_interface.js';
 import type { AvmExecutionEnvironment } from '../avm_execution_environment.js';
 import { NullifierCollisionError, NullifierManager } from './nullifiers.js';
 import { PublicStorage } from './public_storage.js';

yarn-project/simulator/src/providers/acvm_wasm_with_blobs.ts renamed to yarn-project/simulator/src/private/providers/acvm_wasm_with_blobs.ts

@@ -2,7 +2,7 @@ import { Fr } from '@aztec/foundation/fields';
 
 import { type MockProxy, mock } from 'jest-mock-extended';
 
-import type { WorldStateDB } from '../../server.js';
+import type { WorldStateDB } from '../../public_db_sources.js';
 import { NullifierManager } from './nullifiers.js';
 
 describe('avm nullifier caching', () => {

yarn-project/simulator/src/providers/factory.ts renamed to yarn-project/simulator/src/private/providers/factory.ts

@@ -1,6 +1,6 @@
 import type { Fr } from '@aztec/foundation/fields';
 
-import type { WorldStateDB } from '../../server.js';
+import type { WorldStateDB } from '../../public_db_sources.js';
 
 /**
  * A class to manage new nullifier staging and existence checks during a contract call's AVM simulation.