@aztec/simulator 0.55.1 → 0.56.0

package/src/public/phase_manager_factory.ts

@@ -1,126 +0,0 @@
-import { PublicKernelType, type Tx } from '@aztec/circuit-types';
-import { type GlobalVariables, type Header, type PublicKernelCircuitPublicInputs } from '@aztec/circuits.js';
-import { type PublicExecutor, type PublicStateDB } from '@aztec/simulator';
-import { type MerkleTreeOperations } from '@aztec/world-state';
-
-import { type AbstractPhaseManager } from './abstract_phase_manager.js';
-import { AppLogicPhaseManager } from './app_logic_phase_manager.js';
-import { type ContractsDataSourcePublicDB } from './public_db_sources.js';
-import { type PublicKernelCircuitSimulator } from './public_kernel_circuit_simulator.js';
-import { SetupPhaseManager } from './setup_phase_manager.js';
-import { TailPhaseManager } from './tail_phase_manager.js';
-import { TeardownPhaseManager } from './teardown_phase_manager.js';
-
-export class PhaseDidNotChangeError extends Error {
-  constructor(phase: PublicKernelType) {
-    super(`Tried to advance the phase from [${phase}] when the circuit still needs [${phase}]`);
-  }
-}
-
-export class CannotTransitionToSetupError extends Error {
-  constructor() {
-    super('Cannot transition to setup phase');
-  }
-}
-
-export class PhaseManagerFactory {
-  public static phaseFromTx(
-    tx: Tx,
-    db: MerkleTreeOperations,
-    publicExecutor: PublicExecutor,
-    publicKernel: PublicKernelCircuitSimulator,
-    globalVariables: GlobalVariables,
-    historicalHeader: Header,
-    publicContractsDB: ContractsDataSourcePublicDB,
-    publicStateDB: PublicStateDB,
-  ): AbstractPhaseManager | undefined {
-    const data = tx.data.forPublic!;
-    if (data.needsSetup) {
-      return new SetupPhaseManager(
-        db,
-        publicExecutor,
-        publicKernel,
-        globalVariables,
-        historicalHeader,
-        publicContractsDB,
-        publicStateDB,
-      );
-    } else if (data.needsAppLogic) {
-      return new AppLogicPhaseManager(
-        db,
-        publicExecutor,
-        publicKernel,
-        globalVariables,
-        historicalHeader,
-        publicContractsDB,
-        publicStateDB,
-      );
-    } else if (data.needsTeardown) {
-      return new TeardownPhaseManager(
-        db,
-        publicExecutor,
-        publicKernel,
-        globalVariables,
-        historicalHeader,
-        publicContractsDB,
-        publicStateDB,
-      );
-    } else {
-      return undefined;
-    }
-  }
-
-  public static phaseFromOutput(
-    output: PublicKernelCircuitPublicInputs,
-    currentPhaseManager: AbstractPhaseManager,
-    db: MerkleTreeOperations,
-    publicExecutor: PublicExecutor,
-    publicKernel: PublicKernelCircuitSimulator,
-    globalVariables: GlobalVariables,
-    historicalHeader: Header,
-    publicContractsDB: ContractsDataSourcePublicDB,
-    publicStateDB: PublicStateDB,
-  ): AbstractPhaseManager | undefined {
-    if (output.needsSetup) {
-      throw new CannotTransitionToSetupError();
-    } else if (output.needsAppLogic) {
-      if (currentPhaseManager.phase === PublicKernelType.APP_LOGIC) {
-        throw new PhaseDidNotChangeError(currentPhaseManager.phase);
-      }
-      return new AppLogicPhaseManager(
-        db,
-        publicExecutor,
-        publicKernel,
-        globalVariables,
-        historicalHeader,
-        publicContractsDB,
-        publicStateDB,
-      );
-    } else if (output.needsTeardown) {
-      if (currentPhaseManager.phase === PublicKernelType.TEARDOWN) {
-        throw new PhaseDidNotChangeError(currentPhaseManager.phase);
-      }
-      return new TeardownPhaseManager(
-        db,
-        publicExecutor,
-        publicKernel,
-        globalVariables,
-        historicalHeader,
-        publicContractsDB,
-        publicStateDB,
-      );
-    } else if (currentPhaseManager.phase !== PublicKernelType.TAIL) {
-      return new TailPhaseManager(
-        db,
-        publicExecutor,
-        publicKernel,
-        globalVariables,
-        historicalHeader,
-        publicContractsDB,
-        publicStateDB,
-      );
-    } else {
-      return undefined;
-    }
-  }
-}

package/src/public/setup_phase_manager.ts

@@ -1,61 +0,0 @@
-import { PublicKernelType, type PublicProvingRequest, type Tx } from '@aztec/circuit-types';
-import { type GlobalVariables, type Header, type PublicKernelCircuitPublicInputs } from '@aztec/circuits.js';
-import { type ProtocolArtifact } from '@aztec/noir-protocol-circuits-types';
-import { type PublicExecutor, type PublicStateDB } from '@aztec/simulator';
-import { type MerkleTreeOperations } from '@aztec/world-state';
-
-import { AbstractPhaseManager, makeAvmProvingRequest } from './abstract_phase_manager.js';
-import { type ContractsDataSourcePublicDB } from './public_db_sources.js';
-import { type PublicKernelCircuitSimulator } from './public_kernel_circuit_simulator.js';
-
-/**
- * The phase manager responsible for performing the fee preparation phase.
- */
-export class SetupPhaseManager extends AbstractPhaseManager {
-  constructor(
-    db: MerkleTreeOperations,
-    publicExecutor: PublicExecutor,
-    publicKernel: PublicKernelCircuitSimulator,
-    globalVariables: GlobalVariables,
-    historicalHeader: Header,
-    protected publicContractsDB: ContractsDataSourcePublicDB,
-    protected publicStateDB: PublicStateDB,
-    phase: PublicKernelType = PublicKernelType.SETUP,
-  ) {
-    super(db, publicExecutor, publicKernel, globalVariables, historicalHeader, phase);
-  }
-
-  override async handle(
-    tx: Tx,
-    previousPublicKernelOutput: PublicKernelCircuitPublicInputs,
-    previousCircuit: ProtocolArtifact,
-  ) {
-    this.log.verbose(`Processing tx ${tx.getTxHash()}`);
-    // TODO(#6464): Should we allow emitting contracts in the private setup phase?
-    // if so, this should only add contracts that were deployed during private app logic.
-    await this.publicContractsDB.addNewContracts(tx);
-    const { publicProvingInformation, kernelOutput, lastKernelArtifact, newUnencryptedLogs, revertReason, gasUsed } =
-      await this.processEnqueuedPublicCalls(tx, previousPublicKernelOutput, previousCircuit).catch(
-        // the abstract phase manager throws if simulation gives error in a non-revertible phase
-        async err => {
-          await this.publicStateDB.rollbackToCommit();
-          throw err;
-        },
-      );
-    tx.unencryptedLogs.addFunctionLogs(newUnencryptedLogs);
-    await this.publicStateDB.checkpoint();
-
-    // Return a list of setup proving requests
-    const publicProvingRequests: PublicProvingRequest[] = publicProvingInformation.map(info => {
-      return makeAvmProvingRequest(info, PublicKernelType.SETUP);
-    });
-    return {
-      publicProvingRequests,
-      publicKernelOutput: kernelOutput,
-      lastKernelArtifact,
-      revertReason,
-      returnValues: [],
-      gasUsed,
-    };
-  }
-}

package/src/public/tail_phase_manager.ts

@@ -1,127 +0,0 @@
-import { type PublicKernelRequest, PublicKernelType, type Tx } from '@aztec/circuit-types';
-import {
-  type GlobalVariables,
-  type Header,
-  type KernelCircuitPublicInputs,
-  MAX_NULLIFIERS_PER_TX,
-  MAX_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX,
-  type PublicKernelCircuitPublicInputs,
-  PublicKernelTailCircuitPrivateInputs,
-  mergeAccumulatedData,
-} from '@aztec/circuits.js';
-import { type ProtocolArtifact } from '@aztec/noir-protocol-circuits-types';
-import { type PublicExecutor, type PublicStateDB } from '@aztec/simulator';
-import { type MerkleTreeOperations } from '@aztec/world-state';
-
-import { AbstractPhaseManager } from './abstract_phase_manager.js';
-import { type ContractsDataSourcePublicDB } from './public_db_sources.js';
-import { type PublicKernelCircuitSimulator } from './public_kernel_circuit_simulator.js';
-
-export class TailPhaseManager extends AbstractPhaseManager {
-  constructor(
-    db: MerkleTreeOperations,
-    publicExecutor: PublicExecutor,
-    publicKernel: PublicKernelCircuitSimulator,
-    globalVariables: GlobalVariables,
-    historicalHeader: Header,
-    protected publicContractsDB: ContractsDataSourcePublicDB,
-    protected publicStateDB: PublicStateDB,
-    phase: PublicKernelType = PublicKernelType.TAIL,
-  ) {
-    super(db, publicExecutor, publicKernel, globalVariables, historicalHeader, phase);
-  }
-
-  override async handle(
-    tx: Tx,
-    previousPublicKernelOutput: PublicKernelCircuitPublicInputs,
-    previousKernelArtifact: ProtocolArtifact,
-  ) {
-    this.log.verbose(`Processing tx ${tx.getTxHash()}`);
-    const [inputs, finalKernelOutput] = await this.simulate(previousPublicKernelOutput, previousKernelArtifact).catch(
-      // the abstract phase manager throws if simulation gives error in non-revertible phase
-      async err => {
-        await this.publicStateDB.rollbackToCommit();
-        throw err;
-      },
-    );
-
-    // Return a tail proving request
-    const kernelRequest: PublicKernelRequest = {
-      type: PublicKernelType.TAIL,
-      inputs: inputs,
-    };
-
-    return {
-      publicProvingRequests: [kernelRequest],
-      publicKernelOutput: previousPublicKernelOutput,
-      lastKernelArtifact: 'PublicKernelTailArtifact' as ProtocolArtifact,
-      finalKernelOutput,
-      returnValues: [],
-    };
-  }
-
-  private async simulate(
-    previousOutput: PublicKernelCircuitPublicInputs,
-    previousKernelArtifact: ProtocolArtifact,
-  ): Promise<[PublicKernelTailCircuitPrivateInputs, KernelCircuitPublicInputs]> {
-    const inputs = await this.buildPrivateInputs(previousOutput, previousKernelArtifact);
-    // We take a deep copy (clone) of these to pass to the prover
-    return [inputs.clone(), await this.publicKernel.publicKernelCircuitTail(inputs)];
-  }
-
-  private async buildPrivateInputs(
-    previousOutput: PublicKernelCircuitPublicInputs,
-    previousKernelArtifact: ProtocolArtifact,
-  ) {
-    const previousKernel = this.getPreviousKernelData(previousOutput, previousKernelArtifact);
-
-    const { validationRequests, endNonRevertibleData: nonRevertibleData, end: revertibleData } = previousOutput;
-
-    const noteHashReadRequestHints = await this.hintsBuilder.getNoteHashReadRequestsHints(
-      validationRequests.noteHashReadRequests,
-    );
-
-    const pendingNullifiers = mergeAccumulatedData(
-      nonRevertibleData.nullifiers,
-      revertibleData.nullifiers,
-      MAX_NULLIFIERS_PER_TX,
-    );
-
-    const nullifierReadRequestHints = await this.hintsBuilder.getNullifierReadRequestHints(
-      validationRequests.nullifierReadRequests,
-      pendingNullifiers,
-    );
-
-    const nullifierNonExistentReadRequestHints = await this.hintsBuilder.getNullifierNonExistentReadRequestHints(
-      validationRequests.nullifierNonExistentReadRequests,
-      pendingNullifiers,
-    );
-
-    const l1ToL2MsgReadRequestHints = await this.hintsBuilder.getL1ToL2MsgReadRequestsHints(
-      validationRequests.l1ToL2MsgReadRequests,
-    );
-
-    const pendingPublicDataWrites = mergeAccumulatedData(
-      nonRevertibleData.publicDataUpdateRequests,
-      revertibleData.publicDataUpdateRequests,
-      MAX_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX,
-    );
-
-    const publicDataHints = await this.hintsBuilder.getPublicDataHints(
-      validationRequests.publicDataReads,
-      pendingPublicDataWrites,
-    );
-
-    const currentState = await this.db.getStateReference();
-
-    return new PublicKernelTailCircuitPrivateInputs(
-      previousKernel,
-      noteHashReadRequestHints,
-      nullifierReadRequestHints,
-      nullifierNonExistentReadRequestHints,
-      l1ToL2MsgReadRequestHints,
-      publicDataHints,
-      currentState.partial,
-    );
-  }
-}

package/src/public/teardown_phase_manager.ts

@@ -1,86 +0,0 @@
-import { PublicKernelType, type PublicProvingRequest, type Tx } from '@aztec/circuit-types';
-import {
-  type Fr,
-  type Gas,
-  type GlobalVariables,
-  type Header,
-  type PublicKernelCircuitPublicInputs,
-} from '@aztec/circuits.js';
-import { type ProtocolArtifact } from '@aztec/noir-protocol-circuits-types';
-import { type PublicExecutor, type PublicStateDB } from '@aztec/simulator';
-import { type MerkleTreeOperations } from '@aztec/world-state';
-
-import { inspect } from 'util';
-
-import { AbstractPhaseManager, makeAvmProvingRequest } from './abstract_phase_manager.js';
-import { type ContractsDataSourcePublicDB } from './public_db_sources.js';
-import { type PublicKernelCircuitSimulator } from './public_kernel_circuit_simulator.js';
-
-/**
- * The phase manager responsible for performing the fee preparation phase.
- */
-export class TeardownPhaseManager extends AbstractPhaseManager {
-  constructor(
-    db: MerkleTreeOperations,
-    publicExecutor: PublicExecutor,
-    publicKernel: PublicKernelCircuitSimulator,
-    globalVariables: GlobalVariables,
-    historicalHeader: Header,
-    protected publicContractsDB: ContractsDataSourcePublicDB,
-    protected publicStateDB: PublicStateDB,
-    phase: PublicKernelType = PublicKernelType.TEARDOWN,
-  ) {
-    super(db, publicExecutor, publicKernel, globalVariables, historicalHeader, phase);
-  }
-
-  override async handle(
-    tx: Tx,
-    previousPublicKernelOutput: PublicKernelCircuitPublicInputs,
-    previousKernelArtifact: ProtocolArtifact,
-  ) {
-    this.log.verbose(`Processing tx ${tx.getTxHash()}`);
-    const { publicProvingInformation, kernelOutput, lastKernelArtifact, newUnencryptedLogs, revertReason, gasUsed } =
-      await this.processEnqueuedPublicCalls(tx, previousPublicKernelOutput, previousKernelArtifact).catch(
-        // the abstract phase manager throws if simulation gives error in a non-revertible phase
-        async err => {
-          await this.publicStateDB.rollbackToCommit();
-          throw err;
-        },
-      );
-    if (revertReason) {
-      await this.publicStateDB.rollbackToCheckpoint();
-      tx.filterRevertedLogs(kernelOutput);
-    } else {
-      // TODO(#6464): Should we allow emitting contracts in the public teardown phase?
-      // if so, we should insert them here
-      tx.unencryptedLogs.addFunctionLogs(newUnencryptedLogs);
-    }
-
-    // Return a list of teardown proving requests
-    const publicProvingRequests: PublicProvingRequest[] = publicProvingInformation.map(info => {
-      return makeAvmProvingRequest(info, PublicKernelType.TEARDOWN);
-    });
-    return {
-      publicProvingRequests,
-      publicKernelOutput: kernelOutput,
-      lastKernelArtifact,
-      revertReason,
-      returnValues: [],
-      gasUsed,
-    };
-  }
-
-  protected override getTransactionFee(tx: Tx, previousPublicKernelOutput: PublicKernelCircuitPublicInputs): Fr {
-    const gasSettings = tx.data.constants.txContext.gasSettings;
-    const gasFees = this.globalVariables.gasFees;
-    // No need to add teardown limits since they are already included in end.gasUsed
-    const gasUsed = previousPublicKernelOutput.end.gasUsed.add(previousPublicKernelOutput.endNonRevertibleData.gasUsed);
-    const txFee = gasSettings.inclusionFee.add(gasUsed.computeFee(gasFees));
-    this.log.debug(`Computed tx fee`, { txFee, gasUsed: inspect(gasUsed), gasFees: inspect(gasFees) });
-    return txFee;
-  }
-
-  protected override getAvailableGas(tx: Tx, _previousPublicKernelOutput: PublicKernelCircuitPublicInputs): Gas {
-    return tx.data.constants.txContext.gasSettings.getTeardownLimits();
-  }
-}