@aztec/stdlib 0.81.0 → 0.82.0

package/src/contract/interfaces/contract_data_source.ts

@@ -20,12 +20,6 @@ export interface ContractDataSource {
 
   getBytecodeCommitment(id: Fr): Promise<Fr | undefined>;
 
-  /**
-   * Adds a contract class to the database.
-   * TODO(#10007): Remove this method
-   */
-  addContractClass(contractClass: ContractClassPublic): Promise<void>;
-
   /**
    * Returns a publicly deployed contract instance given its address.
    * @param address - Address of the deployed contract.

package/src/database-version/version_manager.ts

@@ -3,6 +3,7 @@ import { jsonParseWithSchemaSync, jsonStringify } from '@aztec/foundation/json-r
 import { createLogger } from '@aztec/foundation/log';
 
 import fs from 'fs/promises';
+import { inspect } from 'node:util';
 import { join } from 'path';
 import { z } from 'zod';
 
@@ -59,6 +60,15 @@ export class DatabaseVersion {
       .transform(({ schemaVersion, rollupAddress }) => new DatabaseVersion(schemaVersion, rollupAddress));
   }
 
+  /** Allows for better introspection. */
+  public [inspect.custom](): string {
+    return this.toString();
+  }
+
+  public toString(): string {
+    return this.schemaVersion.toString();
+  }
+
   /**
    * Returns an empty instance
    */

package/src/interfaces/archiver.ts

@@ -5,7 +5,6 @@ import { z } from 'zod';
 import { inBlockSchemaFor } from '../block/in_block.js';
 import { L2Block } from '../block/l2_block.js';
 import { type L2BlockSource, L2TipsSchema } from '../block/l2_block_source.js';
-import type { NullifierWithBlockSource } from '../block/nullifier_with_block_source.js';
 import { PublishedL2BlockSchema } from '../block/published_l2_block.js';
 import {
   ContractClassPublicSchema,
@@ -26,7 +25,7 @@ import { GetContractClassLogsResponseSchema, GetPublicLogsResponseSchema } from
 import type { L2LogsSource } from './l2_logs_source.js';
 
 export type ArchiverApi = Omit<
-  L2BlockSource & L2LogsSource & ContractDataSource & L1ToL2MessageSource & NullifierWithBlockSource,
+  L2BlockSource & L2LogsSource & ContractDataSource & L1ToL2MessageSource,
   'start' | 'stop'
 >;
 
@@ -53,6 +52,7 @@ export const ArchiverApiSchema: ApiSchemaFor<ArchiverApi> = {
   getL2SlotNumber: z.function().args().returns(schemas.BigInt),
   getL2EpochNumber: z.function().args().returns(schemas.BigInt),
   getBlocksForEpoch: z.function().args(schemas.BigInt).returns(z.array(L2Block.schema)),
+  getBlockHeadersForEpoch: z.function().args(schemas.BigInt).returns(z.array(BlockHeader.schema)),
   isEpochComplete: z.function().args(schemas.BigInt).returns(z.boolean()),
   getL2Tips: z.function().args().returns(L2TipsSchema),
   getPrivateLogs: z.function().args(z.number(), z.number()).returns(z.array(PrivateLog.schema)),
@@ -60,10 +60,6 @@ export const ArchiverApiSchema: ApiSchemaFor<ArchiverApi> = {
     .function()
     .args(z.array(schemas.Fr))
     .returns(z.array(z.array(TxScopedL2Log.schema))),
-  findNullifiersIndexesWithBlock: z
-    .function()
-    .args(z.number(), z.array(schemas.Fr))
-    .returns(z.array(optional(inBlockSchemaFor(schemas.BigInt)))),
   getPublicLogs: z.function().args(LogFilterSchema).returns(GetPublicLogsResponseSchema),
   getContractClassLogs: z.function().args(LogFilterSchema).returns(GetContractClassLogsResponseSchema),
   getContractClass: z.function().args(schemas.Fr).returns(ContractClassPublicSchema.optional()),
@@ -76,8 +72,6 @@ export const ArchiverApiSchema: ApiSchemaFor<ArchiverApi> = {
   registerContractFunctionSignatures: z.function().args(schemas.AztecAddress, z.array(z.string())).returns(z.void()),
   getL1ToL2Messages: z.function().args(schemas.BigInt).returns(z.array(schemas.Fr)),
   getL1ToL2MessageIndex: z.function().args(schemas.Fr).returns(schemas.BigInt.optional()),
-  // TODO(#10007): Remove this method
-  addContractClass: z.function().args(ContractClassPublicSchema).returns(z.void()),
   getContractFunctionName: z
     .function()
     .args(schemas.AztecAddress, schemas.FunctionSelector)

package/src/interfaces/aztec-node-admin.ts

@@ -0,0 +1,39 @@
+import { createSafeJsonRpcClient, defaultFetch } from '@aztec/foundation/json-rpc/client';
+
+import { z } from 'zod';
+
+import type { ApiSchemaFor } from '../schemas/schemas.js';
+import { type ComponentsVersions, getVersioningResponseHandler } from '../versioning/index.js';
+import { type SequencerConfig, SequencerConfigSchema } from './configs.js';
+import { type ProverConfig, ProverConfigSchema } from './prover-client.js';
+
+/**
+ * Aztec node admin API.
+ */
+export interface AztecNodeAdmin {
+  /**
+   * Updates the configuration of this node.
+   * @param config - Updated configuration to be merged with the current one.
+   */
+  setConfig(config: Partial<SequencerConfig & ProverConfig>): Promise<void>;
+
+  /** Forces the next block to be built bypassing all time and pending checks. Useful for testing. */
+  flushTxs(): Promise<void>;
+}
+
+export const AztecNodeAdminApiSchema: ApiSchemaFor<AztecNodeAdmin> = {
+  setConfig: z.function().args(SequencerConfigSchema.merge(ProverConfigSchema).partial()).returns(z.void()),
+  flushTxs: z.function().returns(z.void()),
+};
+
+export function createAztecNodeAdminClient(
+  url: string,
+  versions: Partial<ComponentsVersions> = {},
+  fetch = defaultFetch,
+): AztecNodeAdmin {
+  return createSafeJsonRpcClient<AztecNodeAdmin>(url, AztecNodeAdminApiSchema, {
+    namespaceMethods: 'nodeAdmin',
+    fetch,
+    onResponse: getVersioningResponseHandler(versions),
+  });
+}

package/src/interfaces/aztec-node.ts

@@ -47,14 +47,12 @@ import {
 } from '../tx/index.js';
 import { TxEffect } from '../tx/tx_effect.js';
 import { type ComponentsVersions, getVersioningResponseHandler } from '../versioning/index.js';
-import { type SequencerConfig, SequencerConfigSchema } from './configs.js';
 import {
   type GetContractClassLogsResponse,
   GetContractClassLogsResponseSchema,
   type GetPublicLogsResponse,
   GetPublicLogsResponseSchema,
 } from './get_logs_response.js';
-import { type ProverConfig, ProverConfigSchema } from './prover-client.js';
 import type { ProverCoordination } from './prover-coordination.js';
 import { type WorldStateSyncStatus, WorldStateSyncStatusSchema } from './world_state.js';
 
@@ -76,41 +74,17 @@ export interface AztecNode
   getWorldStateSyncStatus(): Promise<WorldStateSyncStatus>;
 
   /**
-   * Find the indexes of the given leaves in the given tree.
-   * @param blockNumber - The block number at which to get the data or 'latest' for latest data
+   * Find the indexes of the given leaves in the given tree along with a block metadata pointing to the block in which
+   * the leaves were inserted.
+   * @param blockNumber - The block number at which to get the data or 'latest' for latest data.
    * @param treeId - The tree to search in.
-   * @param leafValues - The values to search for
-   * @returns The indexes of the given leaves in the given tree or undefined if not found.
+   * @param leafValues - The values to search for.
+   * @returns The indices of leaves and the block metadata of a block in which the leaves were inserted.
    */
   findLeavesIndexes(
     blockNumber: L2BlockNumber,
     treeId: MerkleTreeId,
     leafValues: Fr[],
-  ): Promise<(bigint | undefined)[]>;
-
-  /**
-   * Find the indexes of the given leaves in the given tree.
-   * @param blockNumber - The block number at which to get the data or 'latest' for latest data
-   * @param treeId - The tree to search in.
-   * @param leafIndices - The values to search for
-   * @returns The indexes of the given leaves in the given tree or undefined if not found.
-   */
-  findBlockNumbersForIndexes(
-    blockNumber: L2BlockNumber,
-    treeId: MerkleTreeId,
-    leafIndices: bigint[],
-  ): Promise<(bigint | undefined)[]>;
-
-  /**
-   * Returns the indexes of the given nullifiers in the nullifier tree,
-   * scoped to the block they were included in.
-   * @param blockNumber - The block number at which to get the data.
-   * @param nullifiers - The nullifiers to search for.
-   * @returns The block scoped indexes of the given nullifiers in the nullifier tree, or undefined if not found.
-   */
-  findNullifiersIndexesWithBlock(
-    blockNumber: L2BlockNumber,
-    nullifiers: Fr[],
   ): Promise<(InBlock<bigint> | undefined)[]>;
 
   /**
@@ -221,14 +195,14 @@ export interface AztecNode
    * "in range" slot, means that the slot doesn't exist and the value is 0. If the low leaf preimage corresponds to the exact slot, the current value
    * is contained in the leaf preimage.
    */
-  getPublicDataTreeWitness(blockNumber: L2BlockNumber, leafSlot: Fr): Promise<PublicDataWitness | undefined>;
+  getPublicDataWitness(blockNumber: L2BlockNumber, leafSlot: Fr): Promise<PublicDataWitness | undefined>;
 
   /**
    * Get a block specified by its number.
    * @param number - The block number being requested.
    * @returns The requested block.
    */
-  getBlock(number: number): Promise<L2Block | undefined>;
+  getBlock(number: L2BlockNumber): Promise<L2Block | undefined>;
 
   /**
    * Fetches the current block number.
@@ -422,12 +396,6 @@ export interface AztecNode
    */
   isValidTx(tx: Tx, options?: { isSimulation?: boolean; skipFeeEnforcement?: boolean }): Promise<TxValidationResult>;
 
-  /**
-   * Updates the configuration of this node.
-   * @param config - Updated configuration to be merged with the current one.
-   */
-  setConfig(config: Partial<SequencerConfig & ProverConfig>): Promise<void>;
-
   /**
    * Returns a registered contract class given its id.
    * @param id - Id of the contract class.
@@ -440,20 +408,10 @@ export interface AztecNode
    */
   getContract(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined>;
 
-  /** Forces the next block to be built bypassing all time and pending checks. Useful for testing. */
-  flushTxs(): Promise<void>;
-
   /**
    * Returns the ENR of this node for peer discovery, if available.
    */
   getEncodedEnr(): Promise<string | undefined>;
-
-  /**
-   * Adds a contract class bypassing the registerer.
-   * TODO(#10007): Remove this method.
-   * @param contractClass - The class to register.
-   */
-  addContractClass(contractClass: ContractClassPublic): Promise<void>;
 }
 
 export const AztecNodeApiSchema: ApiSchemaFor<AztecNode> = {
@@ -464,16 +422,6 @@ export const AztecNodeApiSchema: ApiSchemaFor<AztecNode> = {
   findLeavesIndexes: z
     .function()
     .args(L2BlockNumberSchema, z.nativeEnum(MerkleTreeId), z.array(schemas.Fr))
-    .returns(z.array(optional(schemas.BigInt))),
-
-  findBlockNumbersForIndexes: z
-    .function()
-    .args(L2BlockNumberSchema, z.nativeEnum(MerkleTreeId), z.array(schemas.BigInt))
-    .returns(z.array(optional(schemas.BigInt))),
-
-  findNullifiersIndexesWithBlock: z
-    .function()
-    .args(L2BlockNumberSchema, z.array(schemas.Fr))
     .returns(z.array(optional(inBlockSchemaFor(schemas.BigInt)))),
 
   getNullifierSiblingPath: z
@@ -518,12 +466,9 @@ export const AztecNodeApiSchema: ApiSchemaFor<AztecNode> = {
     .args(L2BlockNumberSchema, schemas.Fr)
     .returns(NullifierMembershipWitness.schema.optional()),
 
-  getPublicDataTreeWitness: z
-    .function()
-    .args(L2BlockNumberSchema, schemas.Fr)
-    .returns(PublicDataWitness.schema.optional()),
+  getPublicDataWitness: z.function().args(L2BlockNumberSchema, schemas.Fr).returns(PublicDataWitness.schema.optional()),
 
-  getBlock: z.function().args(z.number()).returns(L2Block.schema.optional()),
+  getBlock: z.function().args(L2BlockNumberSchema).returns(L2Block.schema.optional()),
 
   getBlockNumber: z.function().returns(z.number()),
 
@@ -590,18 +535,11 @@ export const AztecNodeApiSchema: ApiSchemaFor<AztecNode> = {
     )
     .returns(TxValidationResultSchema),
 
-  setConfig: z.function().args(SequencerConfigSchema.merge(ProverConfigSchema).partial()).returns(z.void()),
-
   getContractClass: z.function().args(schemas.Fr).returns(ContractClassPublicSchema.optional()),
 
   getContract: z.function().args(schemas.AztecAddress).returns(ContractInstanceWithAddressSchema.optional()),
 
-  flushTxs: z.function().returns(z.void()),
-
   getEncodedEnr: z.function().returns(z.string().optional()),
-
-  // TODO(#10007): Remove this method
-  addContractClass: z.function().args(ContractClassPublicSchema).returns(z.void()),
 };
 
 export function createAztecNodeClient(

package/src/interfaces/client.ts

@@ -1,4 +1,5 @@
 export * from './pxe.js';
 export * from './aztec-node.js';
+export * from './aztec-node-admin.js';
 export * from './private_kernel_prover.js';
 export * from './get_logs_response.js';

package/src/interfaces/private_kernel_prover.ts

@@ -1,6 +1,5 @@
-import type { WitnessMap } from '@aztec/noir-acvm_js';
-
 import type {
+  PrivateExecutionStep,
   PrivateKernelCircuitPublicInputs,
   PrivateKernelInitCircuitPrivateInputs,
   PrivateKernelInnerCircuitPrivateInputs,
@@ -101,7 +100,7 @@ export interface PrivateKernelProver {
    * @param acirs The program bytecode.
    * @param witnessStack The witnessses for each program bytecode.
    */
-  createClientIvcProof(acirs: Buffer[], witnessStack: WitnessMap[]): Promise<ClientIvcProof>;
+  createClientIvcProof(executionSteps: PrivateExecutionStep[]): Promise<ClientIvcProof>;
 
   /**
    * Compute the gate count for a given circuit.

package/src/interfaces/prover-node.ts

@@ -11,6 +11,7 @@ const EpochProvingJobState = [
   'failed',
   'stopped',
   'timed-out',
+  'reorg',
 ] as const;
 
 export type EpochProvingJobState = (typeof EpochProvingJobState)[number];
@@ -20,6 +21,7 @@ export const EpochProvingJobTerminalState: EpochProvingJobState[] = [
   'failed',
   'stopped',
   'timed-out',
+  'reorg',
 ] as const;
 
 export type EpochProvingJobTerminalState = (typeof EpochProvingJobTerminalState)[number];
@@ -29,8 +31,6 @@ export interface ProverNodeApi {
   getJobs(): Promise<{ uuid: string; status: EpochProvingJobState; epochNumber: number }[]>;
 
   startProof(epochNumber: number): Promise<void>;
-
-  prove(epochNumber: number): Promise<void>;
 }
 
 /** Schemas for prover node API functions. */
@@ -41,6 +41,4 @@ export const ProverNodeApiSchema: ApiSchemaFor<ProverNodeApi> = {
     .returns(z.array(z.object({ uuid: z.string(), status: z.enum(EpochProvingJobState), epochNumber: z.number() }))),
 
   startProof: z.function().args(schemas.Integer).returns(z.void()),
-
-  prove: z.function().args(schemas.Integer).returns(z.void()),
 };

package/src/interfaces/pxe.ts

@@ -29,15 +29,9 @@ import { type LogFilter, LogFilterSchema } from '../logs/log_filter.js';
 import { UniqueNote } from '../note/extended_note.js';
 import { type NotesFilter, NotesFilterSchema } from '../note/notes_filter.js';
 import { AbiDecodedSchema, optional, schemas } from '../schemas/schemas.js';
-import {
-  PrivateExecutionResult,
-  Tx,
-  TxExecutionRequest,
-  TxHash,
-  TxProvingResult,
-  TxReceipt,
-  TxSimulationResult,
-} from '../tx/index.js';
+import { PrivateExecutionResult, Tx, TxExecutionRequest, TxHash, TxReceipt, TxSimulationResult } from '../tx/index.js';
+import { TxProfileResult } from '../tx/profiled_tx.js';
+import { TxProvingResult } from '../tx/proven_tx.js';
 import { TxEffect } from '../tx/tx_effect.js';
 import {
   type GetContractClassLogsResponse,
@@ -61,38 +55,6 @@ export interface PXE {
    */
   isL1ToL2MessageSynced(l1ToL2Message: Fr): Promise<boolean>;
 
-  /**
-   * Insert an auth witness for a given message hash. Auth witnesses are used to authorize actions on
-   * behalf of a user. For instance, a token transfer initiated by a different address may request
-   * authorization from the user to move their tokens. This authorization is granted by the user
-   * account contract by verifying an auth witness requested to the execution oracle. Witnesses are
-   * usually a signature over a hash of the action to be authorized, but their actual contents depend
-   * on the account contract that consumes them.
-   *
-   * @param authWitness - The auth witness to insert. Composed of an identifier, which is the hash of
-   * the action to be authorized, and the actual witness as an array of fields, which are to be
-   * deserialized and processed by the account contract.
-   */
-  addAuthWitness(authWitness: AuthWitness): Promise<void>;
-
-  /**
-   * Fetches the serialized auth witness for a given message hash or returns undefined if not found.
-   * @param messageHash - The hash of the message for which to get the auth witness.
-   * @returns The serialized auth witness for the given message hash.
-   */
-  getAuthWitness(messageHash: Fr): Promise<Fr[] | undefined>;
-
-  /**
-   * Adds a capsule.
-   * @param contract - The address of the contract to add the capsule to.
-   * @param storageSlot - The storage slot to add the capsule to.
-   * @param capsule - An array of field elements representing the capsule.
-   * @remarks A capsule is a "blob" of data that is passed to the contract through an oracle. It works similarly
-   * to public contract storage in that it's indexed by the contract address and storage slot but instead of the global
-   * network state it's backed by local PXE db.
-   */
-  storeCapsule(contract: AztecAddress, storageSlot: Fr, capsule: Fr[]): Promise<void>;
-
   /**
    * Registers a user account in PXE given its master encryption private key.
    * Once a new account is registered, the PXE Service will trial-decrypt all published notes on
@@ -166,14 +128,13 @@ export interface PXE {
   getContracts(): Promise<AztecAddress[]>;
 
   /**
-   * Creates a proving result based on the provided preauthenticated execution request and the results
-   * of executing the private part of the transaction. This will assemble the zero-knowledge proof for the private execution.
-   * It returns an object that contains the proof and public inputs of the tail circuit, which can be converted into a Tx ready to be sent to the network
+   * Proves the private portion of a simulated transaction, ready to send to the network
+   * (where valiators prove the public portion).
    *
    * @param txRequest - An authenticated tx request ready for proving
    * @param privateExecutionResult - The result of the private execution of the transaction
-   * @returns A transaction ready to be sent to the network for execution.
-   * @throws If the code for the functions executed in this transaction has not been made available via `addContracts`.
+   * @returns A result containing the proof and public inputs of the tail circuit.
+   * @throws If contract code not found, or public simulation reverts.
    * Also throws if simulatePublic is true and public simulation reverts.
    */
   proveTx(txRequest: TxExecutionRequest, privateExecutionResult: PrivateExecutionResult): Promise<TxProvingResult>;
@@ -193,10 +154,10 @@ export interface PXE {
    * @param simulatePublic - Whether to simulate the public part of the transaction.
    * @param msgSender - (Optional) The message sender to use for the simulation.
    * @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
-   * @param profile - (Optional) If true, will run the private kernel prover with profiling enabled and include the result (gate count) in TxSimulationResult.
+   * @param skipFeeEnforcement - (Optional) If false, fees are enforced.
    * @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will default to all.
    * @returns A simulated transaction result object that includes public and private return values.
-   * @throws If the code for the functions executed in this transaction has not been made available via `addContracts`.
+   * @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
    * Also throws if simulatePublic is true and public simulation reverts.
    */
   simulateTx(
@@ -205,10 +166,24 @@ export interface PXE {
     msgSender?: AztecAddress,
     skipTxValidation?: boolean,
     skipFeeEnforcement?: boolean,
-    profile?: boolean,
     scopes?: AztecAddress[],
   ): Promise<TxSimulationResult>;
 
+  /**
+   * Profiles a transaction, reporting gate counts (unless disabled) and returns an execution trace.
+   *
+   * @param txRequest - An authenticated tx request ready for simulation
+   * @param msgSender - (Optional) The message sender to use for the simulation.
+   * @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
+   * @returns A trace of the program execution with gate counts.
+   * @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
+   */
+  profileTx(
+    txRequest: TxExecutionRequest,
+    profileMode: 'gates' | 'execution-steps' | 'full',
+    msgSender?: AztecAddress,
+  ): Promise<TxProfileResult>;
+
   /**
    * Sends a transaction to an Aztec node to be broadcasted to the network and mined.
    * @param tx - The transaction as created via `proveTx`.
@@ -305,6 +280,7 @@ export interface PXE {
     functionName: string,
     args: any[],
     to: AztecAddress,
+    authwits?: AuthWitness[],
     from?: AztecAddress,
     scopes?: AztecAddress[],
   ): Promise<AbiDecoded>;
@@ -454,12 +430,6 @@ const PXEInfoSchema = z.object({
 
 export const PXESchema: ApiSchemaFor<PXE> = {
   isL1ToL2MessageSynced: z.function().args(schemas.Fr).returns(z.boolean()),
-  addAuthWitness: z.function().args(AuthWitness.schema).returns(z.void()),
-  getAuthWitness: z
-    .function()
-    .args(schemas.Fr)
-    .returns(z.union([z.undefined(), z.array(schemas.Fr)])),
-  storeCapsule: z.function().args(schemas.AztecAddress, schemas.Fr, z.array(schemas.Fr)).returns(z.void()),
   registerAccount: z.function().args(schemas.Fr, schemas.Fr).returns(CompleteAddress.schema),
   getRegisteredAccounts: z.function().returns(z.array(CompleteAddress.schema)),
   registerSender: z.function().args(schemas.AztecAddress).returns(schemas.AztecAddress),
@@ -473,6 +443,14 @@ export const PXESchema: ApiSchemaFor<PXE> = {
   updateContract: z.function().args(schemas.AztecAddress, ContractArtifactSchema).returns(z.void()),
   getContracts: z.function().returns(z.array(schemas.AztecAddress)),
   proveTx: z.function().args(TxExecutionRequest.schema, PrivateExecutionResult.schema).returns(TxProvingResult.schema),
+  profileTx: z
+    .function()
+    .args(
+      TxExecutionRequest.schema,
+      z.union([z.literal('gates'), z.literal('full'), z.literal('execution-steps')]),
+      optional(schemas.AztecAddress),
+    )
+    .returns(TxProfileResult.schema),
   simulateTx: z
     .function()
     .args(
@@ -481,7 +459,6 @@ export const PXESchema: ApiSchemaFor<PXE> = {
       optional(schemas.AztecAddress),
       optional(z.boolean()),
       optional(z.boolean()),
-      optional(z.boolean()),
       optional(z.array(schemas.AztecAddress)),
     )
     .returns(TxSimulationResult.schema),
@@ -513,6 +490,7 @@ export const PXESchema: ApiSchemaFor<PXE> = {
       z.string(),
       z.array(z.any()),
       schemas.AztecAddress,
+      optional(z.array(AuthWitness.schema)),
       optional(schemas.AztecAddress),
       optional(z.array(schemas.AztecAddress)),
     )

package/src/kernel/index.ts

@@ -26,5 +26,5 @@ export * from './note_hash.js';
 export * from './private_log_data.js';
 export * from './private_call_request.js';
 export * from './private_validation_requests.js';
-export * from './private_kernel_prover_profile_result.js';
 export * from './private_kernel_simulated_output.js';
+export * from './private_kernel_prover_output.js';

package/src/kernel/private_kernel_prover_output.ts

@@ -0,0 +1,44 @@
+import { bufferSchema, mapSchema } from '@aztec/foundation/schemas';
+import type { WitnessMap } from '@aztec/noir-acvm_js';
+
+import { z } from 'zod';
+
+import type { ClientIvcProof } from '../proofs/client_ivc_proof.js';
+import type { VerificationKeyAsFields } from '../vks/verification_key.js';
+import type { PrivateKernelCircuitPublicInputs } from './private_kernel_circuit_public_inputs.js';
+import type { PrivateKernelTailCircuitPublicInputs } from './private_kernel_tail_circuit_public_inputs.js';
+
+export const PrivateExecutionStepSchema = z.object({
+  functionName: z.string(),
+  gateCount: z.number().optional(),
+  bytecode: bufferSchema,
+  witness: mapSchema(z.number(), z.string()),
+});
+
+/**
+ *  Represents either a simulated private kernel circuit or one of our application function circuits.
+ */
+export interface PrivateExecutionStep {
+  functionName: string;
+  gateCount?: number;
+  bytecode: Buffer;
+  witness: WitnessMap;
+}
+
+/** Represents the output of proven PrivateKernelSimulateOutput.*/
+export interface PrivateKernelExecutionProofOutput<
+  PublicInputsType extends PrivateKernelCircuitPublicInputs | PrivateKernelTailCircuitPublicInputs,
+> {
+  /** The public inputs used by the proof generation process. */
+  publicInputs: PublicInputsType;
+  /** The private IVC proof optimized for user devices. It will be consumed by an Aztec prover,
+   * which recursively verifies it through the "tube" circuit.*/
+  clientIvcProof: ClientIvcProof;
+  verificationKey: VerificationKeyAsFields;
+  /**
+   * The trace the clientIvcProof corresponds to.
+   * A trace of app circuits interleaved with private kernel circuits.
+   * If simulate is ran with profiling mode, also includes gate counts.
+   */
+  executionSteps: PrivateExecutionStep[];
+}

package/src/kernel/private_kernel_simulated_output.ts

@@ -1,31 +1,22 @@
 import type { WitnessMap } from '@aztec/noir-acvm_js';
 
-import type { ClientIvcProof } from '../proofs/client_ivc_proof.js';
 import type { VerificationKeyAsFields } from '../vks/verification_key.js';
 import type { PrivateKernelCircuitPublicInputs } from './private_kernel_circuit_public_inputs.js';
-import type { PrivateKernelProverProfileResult } from './private_kernel_prover_profile_result.js';
 import type { PrivateKernelTailCircuitPublicInputs } from './private_kernel_tail_circuit_public_inputs.js';
 
 /**
  * Represents the output of the proof creation process for init and inner private kernel circuit.
  * Contains the public inputs required for the init and inner private kernel circuit and the generated proof.
  */
-export type PrivateKernelSimulateOutput<
+export interface PrivateKernelSimulateOutput<
   PublicInputsType extends PrivateKernelCircuitPublicInputs | PrivateKernelTailCircuitPublicInputs,
-> = {
+> {
   /** The public inputs required for the proof generation process. */
   publicInputs: PublicInputsType;
-
-  clientIvcProof?: ClientIvcProof;
-
-  verificationKey: VerificationKeyAsFields;
-
   outputWitness: WitnessMap;
-
+  verificationKey: VerificationKeyAsFields;
   bytecode: Buffer;
-
-  profileResult?: PrivateKernelProverProfileResult;
-};
+}
 
 /**
  * Represents the output of the circuit simulation process for init and inner private kernel circuit.

package/src/logs/log_with_tx_data.ts

@@ -1,8 +1,8 @@
 import { MAX_NOTE_HASHES_PER_TX, PUBLIC_LOG_DATA_SIZE_IN_FIELDS } from '@aztec/constants';
 import { Fr } from '@aztec/foundation/fields';
 
-// TypeScript representation of the Noir aztec::oracle::note_discovery::LogWithTxData struct. This is used as a response
-// for PXE's custom getLogByTag oracle.
+// TypeScript representation of the Noir aztec::oracle::message_discovery::LogWithTxData struct. This is used as a
+// response for PXE's custom getLogByTag oracle.
 export class LogWithTxData {
   constructor(
     public logContent: Fr[],

package/src/noir/index.ts

@@ -75,7 +75,7 @@ export interface NoirCompiledContract {
 }
 
 /**
- * The compilation result of an Aztec.nr contract.
+ * The compilation result of a protocol (non-contract) circuit.
  */
 export interface NoirCompiledCircuit {
   /** The hash of the circuit. */
@@ -92,6 +92,11 @@ export interface NoirCompiledCircuit {
   file_map: DebugFileMap;
 }
 
+export interface NoirCompiledCircuitWithName extends NoirCompiledCircuit {
+  /** The name of the circuit. */
+  name: string;
+}
+
 /**
  * The debug metadata of an Aztec.nr contract.
  */