@aztec/stdlib 3.0.0-nightly.20250926 → 3.0.0-nightly.20250928

package/dest/interfaces/pxe.d.ts

@@ -1,235 +0,0 @@
-import type { Fr } from '@aztec/foundation/fields';
-import { z } from 'zod';
-import { type AbiType, type ContractArtifact } from '../abi/abi.js';
-import type { EventSelector } from '../abi/event_selector.js';
-import { AuthWitness } from '../auth_witness/auth_witness.js';
-import type { AztecAddress } from '../aztec-address/index.js';
-import { CompleteAddress, type ContractClassWithId, type ContractInstanceWithAddress, type PartialAddress, type ProtocolContractAddresses } from '../contract/index.js';
-import { UniqueNote } from '../note/extended_note.js';
-import type { NotesFilter } from '../note/notes_filter.js';
-import { SimulationOverrides, TxExecutionRequest, TxSimulationResult } from '../tx/index.js';
-import { TxProfileResult, UtilitySimulationResult } from '../tx/profiling.js';
-import { TxProvingResult } from '../tx/proven_tx.js';
-/**
- * Private eXecution Environment (PXE) runs locally for each user, providing functionality for all the operations
- * needed to interact with the Aztec network, including account management, private data management,
- * transaction local simulation, and access to an Aztec node. This interface, as part of a Wallet,
- * is exposed to dapps for interacting with the network on behalf of the user.
- */
-export interface PXE {
-    /**
-     * 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
-     * the chain and store those that correspond to the registered account. Will do nothing if the
-     * account is already registered.
-     *
-     * @param secretKey - Secret key of the corresponding user master public key.
-     * @param partialAddress - The partial address of the account contract corresponding to the account being registered.
-     * @returns The complete address of the account.
-     */
-    registerAccount(secretKey: Fr, partialAddress: PartialAddress): Promise<CompleteAddress>;
-    /**
-     * Retrieves the user accounts registered on this PXE Service.
-     * @returns An array of the accounts registered on this PXE Service.
-     */
-    getRegisteredAccounts(): Promise<CompleteAddress[]>;
-    /**
-     * Registers a user contact in PXE.
-     *
-     * Once a new contact is registered, the PXE Service will be able to receive notes tagged from this contact.
-     * Will do nothing if the account is already registered.
-     *
-     * @param address - Address of the user to add to the address book
-     * @returns The address address of the account.
-     */
-    registerSender(address: AztecAddress): Promise<AztecAddress>;
-    /**
-     * Retrieves the addresses stored as senders on this PXE Service.
-     * @returns An array of the senders on this PXE Service.
-     */
-    getSenders(): Promise<AztecAddress[]>;
-    /**
-     * Removes a sender in the address book.
-     */
-    removeSender(address: AztecAddress): Promise<void>;
-    /**
-     * Registers a contract class in the PXE without registering any associated contract instance with it.
-     *
-     * @param artifact - The build artifact for the contract class.
-     */
-    registerContractClass(artifact: ContractArtifact): Promise<void>;
-    /**
-     * Adds deployed contracts to the PXE Service. Deployed contract information is used to access the
-     * contract code when simulating local transactions. This is automatically called by aztec.js when
-     * deploying a contract. Dapps that wish to interact with contracts already deployed should register
-     * these contracts in their users' PXE Service through this method.
-     *
-     * @param contract - A contract instance to register, with an optional artifact which can be omitted if the contract class has already been registered.
-     */
-    registerContract(contract: {
-        instance: ContractInstanceWithAddress;
-        artifact?: ContractArtifact;
-    }): Promise<void>;
-    /**
-     * Updates a deployed contract in the PXE Service. This is used to update the contract artifact when
-     * an update has happened, so the new code can be used in the simulation of local transactions.
-     * This is called by aztec.js when instantiating a contract in a given address with a mismatching artifact.
-     * @param contractAddress - The address of the contract to update.
-     * @param artifact - The updated artifact for the contract.
-     * @throws If the artifact's contract class is not found in the PXE or if the contract class is different from
-     * the current one (current one from the point of view of the node to which the PXE is connected).
-     */
-    updateContract(contractAddress: AztecAddress, artifact: ContractArtifact): Promise<void>;
-    /**
-     * Retrieves the addresses of contracts added to this PXE Service.
-     * @returns An array of contracts addresses registered on this PXE Service.
-     */
-    getContracts(): Promise<AztecAddress[]>;
-    /**
-     * Proves the private portion of a simulated transaction, ready to send to the network
-     * (where validators prove the public portion).
-     *
-     * @param txRequest - An authenticated tx request ready for proving
-     * @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): Promise<TxProvingResult>;
-    /**
-     * Simulates a transaction based on the provided preauthenticated execution request.
-     * This will run a local simulation of private execution (and optionally of public as well), run the
-     * kernel circuits to ensure adherence to protocol rules (without generating a proof), and return the
-     * simulation results .
-     *
-     *
-     * Note that this is used with `ContractFunctionInteraction::simulateTx` to bypass certain checks.
-     * In that case, the transaction returned is only potentially ready to be sent to the network for execution.
-     *
-     *
-     * @param txRequest - An authenticated tx request ready for simulation
-     * @param simulatePublic - Whether to simulate the public part of the transaction.
-     * @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
-     * @param skipFeeEnforcement - (Optional) If false, fees are enforced.
-     * @param overrides - (Optional) State overrides for the simulation, such as msgSender, contract instances and artifacts.
-     * @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 have not been made available via `addContracts`.
-     * Also throws if simulatePublic is true and public simulation reverts.
-     */
-    simulateTx(txRequest: TxExecutionRequest, simulatePublic: boolean, skipTxValidation?: boolean, skipFeeEnforcement?: boolean, overrides?: SimulationOverrides, 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', skipProofGeneration?: boolean, msgSender?: AztecAddress): Promise<TxProfileResult>;
-    /**
-     * Gets notes registered in this PXE based on the provided filter.
-     * @param filter - The filter to apply to the notes.
-     * @returns The requested notes.
-     */
-    getNotes(filter: NotesFilter): Promise<UniqueNote[]>;
-    /**
-     * Simulate the execution of a contract utility function.
-     *
-     * @param functionName - The name of the utility contract function to be called.
-     * @param args - The arguments to be provided to the function.
-     * @param to - The address of the contract to be called.
-     * @param authwits - (Optional) The authentication witnesses required for the function call.
-     * @param from - (Optional) The msg sender to set for the call.
-     * @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will
-     * default to all.
-     * @returns The result of the utility function call, structured based on the function ABI.
-     */
-    simulateUtility(functionName: string, args: any[], to: AztecAddress, authwits?: AuthWitness[], from?: AztecAddress, scopes?: AztecAddress[]): Promise<UtilitySimulationResult>;
-    /**
-     * Returns information about this PXE.
-     */
-    getPXEInfo(): Promise<PXEInfo>;
-    /**
-     * Returns the contract metadata given an address.
-     * The metadata consists of its contract instance, which includes the contract class identifier,
-     * initialization hash, deployment salt, and public keys hash; whether the contract instance has been initialized;
-     * and whether the contract instance with the given address has been publicly deployed.
-     * @remark - it queries the node to check whether the contract instance has been initialized / publicly deployed through a node.
-     * This query is not dependent on the PXE.
-     * @param address - The address that the contract instance resides at.
-     * @returns - It returns the contract metadata
-     * TODO(@spalladino): Should we return the public keys in plain as well here?
-     */
-    getContractMetadata(address: AztecAddress): Promise<ContractMetadata>;
-    /**
-     * Returns the contract class metadata given a contract class id.
-     * The metadata consists of its contract class, whether it has been publicly registered, and its artifact.
-     * @remark - it queries the node to check whether the contract class with the given id has been publicly registered.
-     * @param id - Identifier of the class.
-     * @param includeArtifact - Identifier of the class.
-     * @returns - It returns the contract class metadata, with the artifact field being optional, and will only be returned if true is passed in
-     * for `includeArtifact`
-     * TODO(@spalladino): The PXE actually holds artifacts and not classes, what should we return? Also,
-     * should the pxe query the node for contract public info, and merge it with its own definitions?
-     * TODO(@spalladino): This method is strictly needed to decide whether to publicly register a class or not
-     * during a public deployment. We probably want a nicer and more general API for this, but it'll have to
-     * do for the time being.
-     */
-    getContractClassMetadata(id: Fr, includeArtifact?: boolean): Promise<ContractClassMetadata>;
-    /**
-     * Returns the private events given search parameters.
-     * @param contractAddress - The address of the contract to get events from.
-     * @param eventMetadata - Metadata of the event. This should be the class generated from the contract. e.g. Contract.events.Event
-     * @param from - The block number to search from.
-     * @param numBlocks - The amount of blocks to search.
-     * @param recipients - The addresses that decrypted the logs.
-     * @returns - The deserialized events.
-     */
-    getPrivateEvents<T>(contractAddress: AztecAddress, eventMetadata: EventMetadataDefinition, from: number, numBlocks: number, recipients: AztecAddress[]): Promise<T[]>;
-    /**
-     * Stops the PXE's job queue.
-     */
-    stop(): Promise<void>;
-}
-export type EventMetadataDefinition = {
-    eventSelector: EventSelector;
-    abiType: AbiType;
-    fieldNames: string[];
-};
-export declare const EventMetadataDefinitionSchema: z.ZodObject<{
-    eventSelector: z.ZodType<EventSelector, any, string>;
-    abiType: z.ZodType<AbiType, z.ZodTypeDef, AbiType>;
-    fieldNames: z.ZodArray<z.ZodString, "many">;
-}, "strip", z.ZodTypeAny, {
-    eventSelector: EventSelector;
-    abiType: AbiType;
-    fieldNames: string[];
-}, {
-    eventSelector: string;
-    abiType: AbiType;
-    fieldNames: string[];
-}>;
-/** This is used in getting events via the filter */
-export declare enum EventType {
-    Encrypted = "Encrypted",
-    Unencrypted = "Unencrypted"
-}
-/** Provides basic information about the running PXE. */
-export interface PXEInfo {
-    /** Version as tracked in the aztec-packages repository. */
-    pxeVersion: string;
-    /** Protocol contract addresses */
-    protocolContractAddresses: ProtocolContractAddresses;
-}
-export interface ContractMetadata {
-    contractInstance?: ContractInstanceWithAddress | undefined;
-    isContractInitialized: boolean;
-    isContractPublished: boolean;
-}
-export interface ContractClassMetadata {
-    contractClass?: ContractClassWithId | undefined;
-    isContractClassPubliclyRegistered: boolean;
-    artifact?: ContractArtifact | undefined;
-}
-//# sourceMappingURL=pxe.d.ts.map

package/dest/interfaces/pxe.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"pxe.d.ts","sourceRoot":"","sources":["../../src/interfaces/pxe.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAEnD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,KAAK,OAAO,EAAiB,KAAK,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACnF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EACL,eAAe,EACf,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,EAChC,KAAK,cAAc,EACnB,KAAK,yBAAyB,EAC/B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAE3D,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAGrD;;;;;GAKG;AACH,MAAM,WAAW,GAAG;IAClB;;;;;;;;;OASG;IACH,eAAe,CAAC,SAAS,EAAE,EAAE,EAAE,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEzF;;;OAGG;IACH,qBAAqB,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IAEpD;;;;;;;;OAQG;IACH,cAAc,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAE7D;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAEtC;;OAEG;IACH,YAAY,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD;;;;OAIG;IACH,qBAAqB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE;;;;;;;OAOG;IACH,gBAAgB,CAAC,QAAQ,EAAE;QAAE,QAAQ,EAAE,2BAA2B,CAAC;QAAC,QAAQ,CAAC,EAAE,gBAAgB,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElH;;;;;;;;OAQG;IACH,cAAc,CAAC,eAAe,EAAE,YAAY,EAAE,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzF;;;OAGG;IACH,YAAY,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAExC;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAS,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEjE;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,UAAU,CACR,SAAS,EAAE,kBAAkB,EAC7B,cAAc,EAAE,OAAO,EACvB,gBAAgB,CAAC,EAAE,OAAO,EAC1B,kBAAkB,CAAC,EAAE,OAAO,EAC5B,SAAS,CAAC,EAAE,mBAAmB,EAC/B,MAAM,CAAC,EAAE,YAAY,EAAE,GACtB,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAE/B;;;;;;;;OAQG;IACH,SAAS,CACP,SAAS,EAAE,kBAAkB,EAC7B,WAAW,EAAE,OAAO,GAAG,iBAAiB,GAAG,MAAM,EACjD,mBAAmB,CAAC,EAAE,OAAO,EAC7B,SAAS,CAAC,EAAE,YAAY,GACvB,OAAO,CAAC,eAAe,CAAC,CAAC;IAE5B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IAErD;;;;;;;;;;;OAWG;IACH,eAAe,CACb,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,GAAG,EAAE,EACX,EAAE,EAAE,YAAY,EAChB,QAAQ,CAAC,EAAE,WAAW,EAAE,EACxB,IAAI,CAAC,EAAE,YAAY,EACnB,MAAM,CAAC,EAAE,YAAY,EAAE,GACtB,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEpC;;OAEG;IACH,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/B;;;;;;;;;;OAUG;IACH,mBAAmB,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAEtE;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CAAC,EAAE,EAAE,EAAE,EAAE,eAAe,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAE5F;;;;;;;;OAQG;IACH,gBAAgB,CAAC,CAAC,EAChB,eAAe,EAAE,YAAY,EAC7B,aAAa,EAAE,uBAAuB,EACtC,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,YAAY,EAAE,GACzB,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAEhB;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACvB;AAGD,MAAM,MAAM,uBAAuB,GAAG;IACpC,aAAa,EAAE,aAAa,CAAC;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,6BAA6B;;;;;;;;;;;;EAIxC,CAAC;AAEH,oDAAoD;AACpD,oBAAY,SAAS;IACnB,SAAS,cAAc;IACvB,WAAW,gBAAgB;CAC5B;AAED,wDAAwD;AACxD,MAAM,WAAW,OAAO;IACtB,2DAA2D;IAC3D,UAAU,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,yBAAyB,EAAE,yBAAyB,CAAC;CACtD;AAED,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAC;IAC3D,qBAAqB,EAAE,OAAO,CAAC;IAC/B,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,qBAAqB;IACpC,aAAa,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAChD,iCAAiC,EAAE,OAAO,CAAC;IAC3C,QAAQ,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;CACzC"}

package/dest/interfaces/pxe.js

@@ -1,13 +0,0 @@
-import { z } from 'zod';
-import { AbiTypeSchema } from '../abi/abi.js';
-import { schemas } from '../schemas/schemas.js';
-export const EventMetadataDefinitionSchema = z.object({
-    eventSelector: schemas.EventSelector,
-    abiType: AbiTypeSchema,
-    fieldNames: z.array(z.string())
-});
-/** This is used in getting events via the filter */ export var EventType = /*#__PURE__*/ function(EventType) {
-    EventType["Encrypted"] = "Encrypted";
-    EventType["Unencrypted"] = "Unencrypted";
-    return EventType;
-}({});

package/src/interfaces/pxe.ts

@@ -1,284 +0,0 @@
-import type { Fr } from '@aztec/foundation/fields';
-
-import { z } from 'zod';
-
-import { type AbiType, AbiTypeSchema, type ContractArtifact } from '../abi/abi.js';
-import type { EventSelector } from '../abi/event_selector.js';
-import { AuthWitness } from '../auth_witness/auth_witness.js';
-import type { AztecAddress } from '../aztec-address/index.js';
-import {
-  CompleteAddress,
-  type ContractClassWithId,
-  type ContractInstanceWithAddress,
-  type PartialAddress,
-  type ProtocolContractAddresses,
-} from '../contract/index.js';
-import { UniqueNote } from '../note/extended_note.js';
-import type { NotesFilter } from '../note/notes_filter.js';
-import { schemas } from '../schemas/schemas.js';
-import { SimulationOverrides, TxExecutionRequest, TxSimulationResult } from '../tx/index.js';
-import { TxProfileResult, UtilitySimulationResult } from '../tx/profiling.js';
-import { TxProvingResult } from '../tx/proven_tx.js';
-
-// docs:start:pxe-interface
-/**
- * Private eXecution Environment (PXE) runs locally for each user, providing functionality for all the operations
- * needed to interact with the Aztec network, including account management, private data management,
- * transaction local simulation, and access to an Aztec node. This interface, as part of a Wallet,
- * is exposed to dapps for interacting with the network on behalf of the user.
- */
-export interface PXE {
-  /**
-   * 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
-   * the chain and store those that correspond to the registered account. Will do nothing if the
-   * account is already registered.
-   *
-   * @param secretKey - Secret key of the corresponding user master public key.
-   * @param partialAddress - The partial address of the account contract corresponding to the account being registered.
-   * @returns The complete address of the account.
-   */
-  registerAccount(secretKey: Fr, partialAddress: PartialAddress): Promise<CompleteAddress>;
-
-  /**
-   * Retrieves the user accounts registered on this PXE Service.
-   * @returns An array of the accounts registered on this PXE Service.
-   */
-  getRegisteredAccounts(): Promise<CompleteAddress[]>;
-
-  /**
-   * Registers a user contact in PXE.
-   *
-   * Once a new contact is registered, the PXE Service will be able to receive notes tagged from this contact.
-   * Will do nothing if the account is already registered.
-   *
-   * @param address - Address of the user to add to the address book
-   * @returns The address address of the account.
-   */
-  registerSender(address: AztecAddress): Promise<AztecAddress>;
-
-  /**
-   * Retrieves the addresses stored as senders on this PXE Service.
-   * @returns An array of the senders on this PXE Service.
-   */
-  getSenders(): Promise<AztecAddress[]>;
-
-  /**
-   * Removes a sender in the address book.
-   */
-  removeSender(address: AztecAddress): Promise<void>;
-
-  /**
-   * Registers a contract class in the PXE without registering any associated contract instance with it.
-   *
-   * @param artifact - The build artifact for the contract class.
-   */
-  registerContractClass(artifact: ContractArtifact): Promise<void>;
-
-  /**
-   * Adds deployed contracts to the PXE Service. Deployed contract information is used to access the
-   * contract code when simulating local transactions. This is automatically called by aztec.js when
-   * deploying a contract. Dapps that wish to interact with contracts already deployed should register
-   * these contracts in their users' PXE Service through this method.
-   *
-   * @param contract - A contract instance to register, with an optional artifact which can be omitted if the contract class has already been registered.
-   */
-  registerContract(contract: { instance: ContractInstanceWithAddress; artifact?: ContractArtifact }): Promise<void>;
-
-  /**
-   * Updates a deployed contract in the PXE Service. This is used to update the contract artifact when
-   * an update has happened, so the new code can be used in the simulation of local transactions.
-   * This is called by aztec.js when instantiating a contract in a given address with a mismatching artifact.
-   * @param contractAddress - The address of the contract to update.
-   * @param artifact - The updated artifact for the contract.
-   * @throws If the artifact's contract class is not found in the PXE or if the contract class is different from
-   * the current one (current one from the point of view of the node to which the PXE is connected).
-   */
-  updateContract(contractAddress: AztecAddress, artifact: ContractArtifact): Promise<void>;
-
-  /**
-   * Retrieves the addresses of contracts added to this PXE Service.
-   * @returns An array of contracts addresses registered on this PXE Service.
-   */
-  getContracts(): Promise<AztecAddress[]>;
-
-  /**
-   * Proves the private portion of a simulated transaction, ready to send to the network
-   * (where validators prove the public portion).
-   *
-   * @param txRequest - An authenticated tx request ready for proving
-   * @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): Promise<TxProvingResult>;
-
-  /**
-   * Simulates a transaction based on the provided preauthenticated execution request.
-   * This will run a local simulation of private execution (and optionally of public as well), run the
-   * kernel circuits to ensure adherence to protocol rules (without generating a proof), and return the
-   * simulation results .
-   *
-   *
-   * Note that this is used with `ContractFunctionInteraction::simulateTx` to bypass certain checks.
-   * In that case, the transaction returned is only potentially ready to be sent to the network for execution.
-   *
-   *
-   * @param txRequest - An authenticated tx request ready for simulation
-   * @param simulatePublic - Whether to simulate the public part of the transaction.
-   * @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
-   * @param skipFeeEnforcement - (Optional) If false, fees are enforced.
-   * @param overrides - (Optional) State overrides for the simulation, such as msgSender, contract instances and artifacts.
-   * @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 have not been made available via `addContracts`.
-   * Also throws if simulatePublic is true and public simulation reverts.
-   */
-  simulateTx(
-    txRequest: TxExecutionRequest,
-    simulatePublic: boolean,
-    skipTxValidation?: boolean,
-    skipFeeEnforcement?: boolean,
-    overrides?: SimulationOverrides,
-    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',
-    skipProofGeneration?: boolean,
-    msgSender?: AztecAddress,
-  ): Promise<TxProfileResult>;
-
-  /**
-   * Gets notes registered in this PXE based on the provided filter.
-   * @param filter - The filter to apply to the notes.
-   * @returns The requested notes.
-   */
-  getNotes(filter: NotesFilter): Promise<UniqueNote[]>;
-
-  /**
-   * Simulate the execution of a contract utility function.
-   *
-   * @param functionName - The name of the utility contract function to be called.
-   * @param args - The arguments to be provided to the function.
-   * @param to - The address of the contract to be called.
-   * @param authwits - (Optional) The authentication witnesses required for the function call.
-   * @param from - (Optional) The msg sender to set for the call.
-   * @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will
-   * default to all.
-   * @returns The result of the utility function call, structured based on the function ABI.
-   */
-  simulateUtility(
-    functionName: string,
-    args: any[],
-    to: AztecAddress,
-    authwits?: AuthWitness[],
-    from?: AztecAddress,
-    scopes?: AztecAddress[],
-  ): Promise<UtilitySimulationResult>;
-
-  /**
-   * Returns information about this PXE.
-   */
-  getPXEInfo(): Promise<PXEInfo>;
-
-  /**
-   * Returns the contract metadata given an address.
-   * The metadata consists of its contract instance, which includes the contract class identifier,
-   * initialization hash, deployment salt, and public keys hash; whether the contract instance has been initialized;
-   * and whether the contract instance with the given address has been publicly deployed.
-   * @remark - it queries the node to check whether the contract instance has been initialized / publicly deployed through a node.
-   * This query is not dependent on the PXE.
-   * @param address - The address that the contract instance resides at.
-   * @returns - It returns the contract metadata
-   * TODO(@spalladino): Should we return the public keys in plain as well here?
-   */
-  getContractMetadata(address: AztecAddress): Promise<ContractMetadata>;
-
-  /**
-   * Returns the contract class metadata given a contract class id.
-   * The metadata consists of its contract class, whether it has been publicly registered, and its artifact.
-   * @remark - it queries the node to check whether the contract class with the given id has been publicly registered.
-   * @param id - Identifier of the class.
-   * @param includeArtifact - Identifier of the class.
-   * @returns - It returns the contract class metadata, with the artifact field being optional, and will only be returned if true is passed in
-   * for `includeArtifact`
-   * TODO(@spalladino): The PXE actually holds artifacts and not classes, what should we return? Also,
-   * should the pxe query the node for contract public info, and merge it with its own definitions?
-   * TODO(@spalladino): This method is strictly needed to decide whether to publicly register a class or not
-   * during a public deployment. We probably want a nicer and more general API for this, but it'll have to
-   * do for the time being.
-   */
-  getContractClassMetadata(id: Fr, includeArtifact?: boolean): Promise<ContractClassMetadata>;
-
-  /**
-   * Returns the private events given search parameters.
-   * @param contractAddress - The address of the contract to get events from.
-   * @param eventMetadata - Metadata of the event. This should be the class generated from the contract. e.g. Contract.events.Event
-   * @param from - The block number to search from.
-   * @param numBlocks - The amount of blocks to search.
-   * @param recipients - The addresses that decrypted the logs.
-   * @returns - The deserialized events.
-   */
-  getPrivateEvents<T>(
-    contractAddress: AztecAddress,
-    eventMetadata: EventMetadataDefinition,
-    from: number,
-    numBlocks: number,
-    recipients: AztecAddress[],
-  ): Promise<T[]>;
-
-  /**
-   * Stops the PXE's job queue.
-   */
-  stop(): Promise<void>;
-}
-// docs:end:pxe-interface
-
-export type EventMetadataDefinition = {
-  eventSelector: EventSelector;
-  abiType: AbiType;
-  fieldNames: string[];
-};
-
-export const EventMetadataDefinitionSchema = z.object({
-  eventSelector: schemas.EventSelector,
-  abiType: AbiTypeSchema,
-  fieldNames: z.array(z.string()),
-});
-
-/** This is used in getting events via the filter */
-export enum EventType {
-  Encrypted = 'Encrypted',
-  Unencrypted = 'Unencrypted',
-}
-
-/** Provides basic information about the running PXE. */
-export interface PXEInfo {
-  /** Version as tracked in the aztec-packages repository. */
-  pxeVersion: string;
-  /** Protocol contract addresses */
-  protocolContractAddresses: ProtocolContractAddresses;
-}
-
-export interface ContractMetadata {
-  contractInstance?: ContractInstanceWithAddress | undefined;
-  isContractInitialized: boolean;
-  isContractPublished: boolean;
-}
-
-export interface ContractClassMetadata {
-  contractClass?: ContractClassWithId | undefined;
-  isContractClassPubliclyRegistered: boolean;
-  artifact?: ContractArtifact | undefined;
-}