@aztec/pxe 3.0.0-canary.a9708bd → 3.0.0-devnet.20251212

package/src/{pxe_service/pxe_service.ts → pxe.ts}

@@ -1,17 +1,12 @@
-import { L1_TO_L2_MSG_TREE_HEIGHT } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/fields';
+import type { PrivateEventFilter } from '@aztec/aztec.js/wallet';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { type Logger, createLogger } from '@aztec/foundation/log';
 import { SerialQueue } from '@aztec/foundation/queue';
 import { Timer } from '@aztec/foundation/timer';
-import type { SiblingPath } from '@aztec/foundation/trees';
 import { KeyStore } from '@aztec/key-store';
 import type { AztecAsyncKVStore } from '@aztec/kv-store';
 import { L2TipsKVStore } from '@aztec/kv-store/stores';
-import {
-  ProtocolContractAddress,
-  type ProtocolContractsProvider,
-  protocolContractNames,
-} from '@aztec/protocol-contracts';
+import { type ProtocolContractsProvider, protocolContractNames } from '@aztec/protocol-contracts';
 import type { CircuitSimulator } from '@aztec/simulator/client';
 import {
   type ContractArtifact,
@@ -19,46 +14,32 @@ import {
   FunctionCall,
   FunctionSelector,
   FunctionType,
-  decodeFromAbi,
   decodeFunctionSignature,
   encodeArguments,
 } from '@aztec/stdlib/abi';
 import type { AuthWitness } from '@aztec/stdlib/auth-witness';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { L2Block } from '@aztec/stdlib/block';
 import {
   CompleteAddress,
   type ContractClassWithId,
   type ContractInstanceWithAddress,
-  type NodeInfo,
   type PartialAddress,
   computeContractAddressFromInstance,
   getContractClassFromArtifact,
 } from '@aztec/stdlib/contract';
 import { SimulationError } from '@aztec/stdlib/errors';
-import type { GasFees } from '@aztec/stdlib/gas';
-import { siloNullifier } from '@aztec/stdlib/hash';
-import type {
-  AztecNode,
-  EventMetadataDefinition,
-  GetContractClassLogsResponse,
-  GetPublicLogsResponse,
-  PXE,
-  PXEInfo,
-  PrivateKernelProver,
-} from '@aztec/stdlib/interfaces/client';
+import { computeProtocolNullifier, siloNullifier } from '@aztec/stdlib/hash';
+import type { AztecNode, PrivateKernelProver } from '@aztec/stdlib/interfaces/client';
 import type {
   PrivateExecutionStep,
   PrivateKernelExecutionProofOutput,
   PrivateKernelTailCircuitPublicInputs,
 } from '@aztec/stdlib/kernel';
-import type { LogFilter } from '@aztec/stdlib/logs';
-import { computeL2ToL1MembershipWitness, getNonNullifiedL1ToL2MessageWitness } from '@aztec/stdlib/messaging';
-import { type NotesFilter, UniqueNote } from '@aztec/stdlib/note';
-import { MerkleTreeId } from '@aztec/stdlib/trees';
+import type { NotesFilter } from '@aztec/stdlib/note';
+import { NoteDao } from '@aztec/stdlib/note';
 import {
   type ContractOverrides,
-  type IndexedTxEffect,
+  type InTx,
   PrivateExecutionResult,
   PrivateSimulationResult,
   type ProvingTimings,
@@ -67,47 +48,49 @@ import {
   type SimulationTimings,
   Tx,
   TxExecutionRequest,
-  type TxHash,
   TxProfileResult,
   TxProvingResult,
-  type TxReceipt,
   TxSimulationResult,
   UtilitySimulationResult,
 } from '@aztec/stdlib/tx';
 
 import { inspect } from 'util';
 
-import type { PXEServiceConfig } from '../config/index.js';
-import { getPackageInfo } from '../config/package_info.js';
+import type { PXEConfig } from './config/index.js';
 import {
   ContractFunctionSimulator,
   generateSimulatedProvingResult,
-} from '../contract_function_simulator/contract_function_simulator.js';
-import { readCurrentClassId } from '../contract_function_simulator/oracle/private_execution.js';
-import { ProxiedContractDataProviderFactory } from '../contract_function_simulator/proxied_contract_data_source.js';
-import { ProxiedNodeFactory } from '../contract_function_simulator/proxied_node.js';
-import { PXEOracleInterface } from '../contract_function_simulator/pxe_oracle_interface.js';
+} from './contract_function_simulator/contract_function_simulator.js';
+import { readCurrentClassId } from './contract_function_simulator/oracle/private_execution.js';
+import { ProxiedContractDataProviderFactory } from './contract_function_simulator/proxied_contract_data_source.js';
+import { ProxiedNodeFactory } from './contract_function_simulator/proxied_node.js';
+import { PXEOracleInterface } from './contract_function_simulator/pxe_oracle_interface.js';
+import { enrichPublicSimulationError, enrichSimulationError } from './error_enriching.js';
+import { PrivateEventFilterValidator } from './events/private_event_filter_validator.js';
 import {
   PrivateKernelExecutionProver,
   type PrivateKernelExecutionProverConfig,
-} from '../private_kernel/private_kernel_execution_prover.js';
-import { PrivateKernelOracleImpl } from '../private_kernel/private_kernel_oracle_impl.js';
-import { AddressDataProvider } from '../storage/address_data_provider/address_data_provider.js';
-import { CapsuleDataProvider } from '../storage/capsule_data_provider/capsule_data_provider.js';
-import { ContractDataProvider } from '../storage/contract_data_provider/contract_data_provider.js';
-import { NoteDataProvider } from '../storage/note_data_provider/note_data_provider.js';
-import { PrivateEventDataProvider } from '../storage/private_event_data_provider/private_event_data_provider.js';
-import { SyncDataProvider } from '../storage/sync_data_provider/sync_data_provider.js';
-import { TaggingDataProvider } from '../storage/tagging_data_provider/tagging_data_provider.js';
-import { Synchronizer } from '../synchronizer/index.js';
-import { enrichPublicSimulationError, enrichSimulationError } from './error_enriching.js';
+} from './private_kernel/private_kernel_execution_prover.js';
+import { PrivateKernelOracleImpl } from './private_kernel/private_kernel_oracle_impl.js';
+import { AddressDataProvider } from './storage/address_data_provider/address_data_provider.js';
+import { CapsuleDataProvider } from './storage/capsule_data_provider/capsule_data_provider.js';
+import { ContractDataProvider } from './storage/contract_data_provider/contract_data_provider.js';
+import { NoteDataProvider } from './storage/note_data_provider/note_data_provider.js';
+import { PrivateEventDataProvider } from './storage/private_event_data_provider/private_event_data_provider.js';
+import { SyncDataProvider } from './storage/sync_data_provider/sync_data_provider.js';
+import { TaggingDataProvider } from './storage/tagging_data_provider/tagging_data_provider.js';
+import { Synchronizer } from './synchronizer/index.js';
+
+export type PackedPrivateEvent = InTx & {
+  packedEvent: Fr[];
+  eventSelector: EventSelector;
+};
 
 /**
- * A Private eXecution Environment (PXE) implementation.
+ * Private eXecution Environment (PXE) is a library used by wallets to simulate private phase of transactions and to
+ * manage private state of users.
  */
-export class PXEService implements PXE {
-  #nodeInfo?: NodeInfo;
-
+export class PXE {
   private constructor(
     private node: AztecNode,
     private synchronizer: Synchronizer,
@@ -120,7 +103,6 @@ export class PXEService implements PXE {
     private addressDataProvider: AddressDataProvider,
     private privateEventDataProvider: PrivateEventDataProvider,
     private simulator: CircuitSimulator,
-    private packageVersion: string,
     private proverEnabled: boolean,
     private proofCreator: PrivateKernelProver,
     private protocolContractsProvider: ProtocolContractsProvider,
@@ -129,11 +111,11 @@ export class PXEService implements PXE {
   ) {}
 
   /**
-   * Creates an instance of a PXE Service by instantiating all the necessary data providers and services.
+   * Creates an instance of a PXE by instantiating all the necessary data providers and services.
    * Also triggers the registration of the protocol contracts and makes sure the provided node
    * can be contacted.
    *
-   * @returns A promise that resolves PXE service is ready to be used.
+   * @returns A promise that resolves PXE is ready to be used.
    */
   public static async create(
     node: AztecNode,
@@ -141,7 +123,7 @@ export class PXEService implements PXE {
     proofCreator: PrivateKernelProver,
     simulator: CircuitSimulator,
     protocolContractsProvider: ProtocolContractsProvider,
-    config: PXEServiceConfig,
+    config: PXEConfig,
     loggerOrSuffix?: string | Logger,
   ) {
     const log =
@@ -149,7 +131,6 @@ export class PXEService implements PXE {
         ? createLogger(loggerOrSuffix ? `pxe:service:${loggerOrSuffix}` : `pxe:service`)
         : loggerOrSuffix;
 
-    const packageVersion = getPackageInfo().version;
     const proverEnabled = !!config.proverEnabled;
     const addressDataProvider = new AddressDataProvider(store);
     const privateEventDataProvider = new PrivateEventDataProvider(store);
@@ -172,7 +153,7 @@ export class PXEService implements PXE {
 
     const jobQueue = new SerialQueue();
 
-    const pxeService = new PXEService(
+    const pxe = new PXE(
       node,
       synchronizer,
       keyStore,
@@ -184,7 +165,6 @@ export class PXEService implements PXE {
       addressDataProvider,
       privateEventDataProvider,
       simulator,
-      packageVersion,
       proverEnabled,
       proofCreator,
       protocolContractsProvider,
@@ -192,65 +172,12 @@ export class PXEService implements PXE {
       jobQueue,
     );
 
-    pxeService.jobQueue.start();
+    pxe.jobQueue.start();
 
-    await pxeService.#registerProtocolContracts();
-    const info = await pxeService.getNodeInfo();
+    await pxe.#registerProtocolContracts();
+    const info = await node.getNodeInfo();
     log.info(`Started PXE connected to chain ${info.l1ChainId} version ${info.rollupVersion}`);
-    return pxeService;
-  }
-
-  // Aztec node proxy methods
-
-  public isL1ToL2MessageSynced(l1ToL2Message: Fr): Promise<boolean> {
-    return this.node.isL1ToL2MessageSynced(l1ToL2Message);
-  }
-
-  public async getL2ToL1MembershipWitness(
-    blockNumber: number,
-    l2Tol1Message: Fr,
-  ): Promise<[bigint, SiblingPath<number>]> {
-    const result = await computeL2ToL1MembershipWitness(this.node, blockNumber, l2Tol1Message);
-    if (!result) {
-      throw new Error(`L2 to L1 message not found in block ${blockNumber}`);
-    }
-    return [result.leafIndex, result.siblingPath];
-  }
-
-  public getTxReceipt(txHash: TxHash): Promise<TxReceipt> {
-    return this.node.getTxReceipt(txHash);
-  }
-
-  public getTxEffect(txHash: TxHash): Promise<IndexedTxEffect | undefined> {
-    return this.node.getTxEffect(txHash);
-  }
-
-  public getBlockNumber(): Promise<number> {
-    return this.node.getBlockNumber();
-  }
-
-  public getProvenBlockNumber(): Promise<number> {
-    return this.node.getProvenBlockNumber();
-  }
-
-  public getPublicLogs(filter: LogFilter): Promise<GetPublicLogsResponse> {
-    return this.node.getPublicLogs(filter);
-  }
-
-  public getContractClassLogs(filter: LogFilter): Promise<GetContractClassLogsResponse> {
-    return this.node.getContractClassLogs(filter);
-  }
-
-  public getPublicStorageAt(contract: AztecAddress, slot: Fr) {
-    return this.node.getPublicStorageAt('latest', contract, slot);
-  }
-
-  public async getL1ToL2MembershipWitness(
-    contractAddress: AztecAddress,
-    messageHash: Fr,
-    secret: Fr,
-  ): Promise<[bigint, SiblingPath<typeof L1_TO_L2_MSG_TREE_HEIGHT>]> {
-    return await getNonNullifiedL1ToL2MessageWitness(this.node, contractAddress, messageHash, secret);
+    return pxe;
   }
 
   // Internal methods
@@ -331,7 +258,7 @@ export class PXEService implements PXE {
     const contract = await this.contractDataProvider.getContract(to);
     if (!contract) {
       throw new Error(
-        `Unknown contract ${to}: add it to PXE Service by calling server.addContracts(...).\nSee docs for context: https://docs.aztec.network/developers/reference/debugging/aztecnr-errors#unknown-contract-0x0-add-it-to-pxe-by-calling-serveraddcontracts`,
+        `Unknown contract ${to}: add it to PXE by calling server.addContracts(...).\nSee docs for context: https://docs.aztec.network/developers/resources/debugging/aztecnr-errors#unknown-contract-0x0-add-it-to-pxe-by-calling-serveraddcontracts`,
       );
     }
 
@@ -346,6 +273,7 @@ export class PXEService implements PXE {
       selector: await FunctionSelector.fromNameAndParameters(functionDao.name, functionDao.parameters),
       type: functionDao.functionType,
       to,
+      hideMsgSender: false,
       isStatic: functionDao.isStatic,
       returnTypes: functionDao.returnTypes,
     };
@@ -442,7 +370,7 @@ export class PXEService implements PXE {
    * @param proofCreator - The proof creator to use for proving the execution.
    * @param privateExecutionResult - The result of the private execution
    * @param config - The configuration for the kernel execution prover.
-   * @returns An object that contains the output of the kernel execution, including the ClientIvcProof if proving is enabled.
+   * @returns An object that contains the output of the kernel execution, including the ChonkProof if proving is enabled.
    */
   async #prove(
     txExecutionRequest: TxExecutionRequest,
@@ -450,8 +378,13 @@ export class PXEService implements PXE {
     privateExecutionResult: PrivateExecutionResult,
     config: PrivateKernelExecutionProverConfig,
   ): Promise<PrivateKernelExecutionProofOutput<PrivateKernelTailCircuitPublicInputs>> {
-    const block = privateExecutionResult.getSimulationBlockNumber();
-    const kernelOracle = new PrivateKernelOracleImpl(this.contractDataProvider, this.keyStore, this.node, block);
+    const simulationAnchorBlock = privateExecutionResult.getSimulationAnchorBlockNumber();
+    const kernelOracle = new PrivateKernelOracleImpl(
+      this.contractDataProvider,
+      this.keyStore,
+      this.node,
+      simulationAnchorBlock,
+    );
     const kernelTraceProver = new PrivateKernelExecutionProver(kernelOracle, proofCreator, !this.proverEnabled);
     this.log.debug(`Executing kernel trace prover (${JSON.stringify(config)})...`);
     return await kernelTraceProver.proveWithKernels(txExecutionRequest.toTxRequest(), privateExecutionResult, config);
@@ -459,24 +392,24 @@ export class PXEService implements PXE {
 
   // Public API
 
-  /** Returns an estimate of the db size in bytes. */
-  public async estimateDbSize() {
-    const treeRootsSize = Object.keys(MerkleTreeId).length * Fr.SIZE_IN_BYTES;
-    const dbSizes = await Promise.all([
-      this.addressDataProvider.getSize(),
-      this.capsuleDataProvider.getSize(),
-      this.contractDataProvider.getSize(),
-      this.noteDataProvider.getSize(),
-      this.syncDataProvider.getSize(),
-      this.taggingDataProvider.getSize(),
-    ]);
-    return [...dbSizes, treeRootsSize].reduce((sum, size) => sum + size, 0);
-  }
-
   public getContractInstance(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined> {
     return this.contractDataProvider.getContractInstance(address);
   }
 
+  /**
+   * 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.
+   */
   public async getContractClassMetadata(
     id: Fr,
     includeArtifact: boolean = false,
@@ -497,6 +430,17 @@ export class PXEService implements PXE {
     };
   }
 
+  /**
+   * 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?
+   */
   public async getContractMetadata(address: AztecAddress): Promise<{
     contractInstance: ContractInstanceWithAddress | undefined;
     isContractInitialized: boolean;
@@ -515,6 +459,16 @@ export class PXEService implements PXE {
     };
   }
 
+  /**
+   * Registers a user account in PXE given its master encryption private key.
+   * Once a new account is registered, the PXE 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.
+   */
   public async registerAccount(secretKey: Fr, partialAddress: PartialAddress): Promise<CompleteAddress> {
     const accounts = await this.keyStore.getAccounts();
     const accountCompleteAddress = await this.keyStore.addAccount(secretKey, partialAddress);
@@ -531,6 +485,15 @@ export class PXEService implements PXE {
     return accountCompleteAddress;
   }
 
+  /**
+   * Registers a user contact in PXE.
+   *
+   * Once a new contact is registered, the PXE 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.
+   */
   public async registerSender(address: AztecAddress): Promise<AztecAddress> {
     const accounts = await this.keyStore.getAccounts();
     if (accounts.includes(address)) {
@@ -549,10 +512,17 @@ export class PXEService implements PXE {
     return address;
   }
 
+  /**
+   * Retrieves the addresses stored as senders on this PXE.
+   * @returns An array of the senders on this PXE.
+   */
   public getSenders(): Promise<AztecAddress[]> {
     return this.taggingDataProvider.getSenderAddresses();
   }
 
+  /**
+   * Removes a sender in the address book.
+   */
   public async removeSender(address: AztecAddress): Promise<void> {
     const wasRemoved = await this.taggingDataProvider.removeSenderAddress(address);
 
@@ -563,6 +533,10 @@ export class PXEService implements PXE {
     }
   }
 
+  /**
+   * Retrieves the user accounts registered on this PXE.
+   * @returns An array of the accounts registered on this PXE.
+   */
   public async getRegisteredAccounts(): Promise<CompleteAddress[]> {
     // Get complete addresses of both the recipients and the accounts
     const completeAddresses = await this.addressDataProvider.getCompleteAddresses();
@@ -573,12 +547,25 @@ export class PXEService implements PXE {
     );
   }
 
+  /**
+   * Registers a contract class in the PXE without registering any associated contract instance with it.
+   *
+   * @param artifact - The build artifact for the contract class.
+   */
   public async registerContractClass(artifact: ContractArtifact): Promise<void> {
     const { id: contractClassId } = await getContractClassFromArtifact(artifact);
     await this.contractDataProvider.addContractArtifact(contractClassId, artifact);
     this.log.info(`Added contract class ${artifact.name} with id ${contractClassId}`);
   }
 
+  /**
+   * Adds deployed contracts to the PXE. 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 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.
+   */
   public async registerContract(contract: { instance: ContractInstanceWithAddress; artifact?: ContractArtifact }) {
     const { instance } = contract;
     let { artifact } = contract;
@@ -618,6 +605,15 @@ export class PXEService implements PXE {
     );
   }
 
+  /**
+   * Updates a deployed contract in the PXE. 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).
+   */
   public updateContract(contractAddress: AztecAddress, artifact: ContractArtifact): Promise<void> {
     // We disable concurrently updating contracts to avoid concurrently syncing with the node, or changing a contract's
     // class while we're simulating it.
@@ -655,67 +651,58 @@ export class PXEService implements PXE {
     });
   }
 
+  /**
+   * Retrieves the addresses of contracts added to this PXE.
+   * @returns An array of contracts addresses registered on this PXE.
+   */
   public getContracts(): Promise<AztecAddress[]> {
     return this.contractDataProvider.getContractsAddresses();
   }
 
-  public async getNotes(filter: NotesFilter): Promise<UniqueNote[]> {
-    // We need to manually trigger private state sync to have a guarantee that all the events are available.
-    await this.simulateUtility('sync_private_state', [], filter.contractAddress);
-
-    const noteDaos = await this.noteDataProvider.getNotes(filter);
-
-    const extendedNotes = noteDaos.map(async dao => {
-      let recipient = filter.recipient;
-      if (recipient === undefined) {
-        const completeAddresses = await this.addressDataProvider.getCompleteAddresses();
-        const completeAddressIndex = completeAddresses.findIndex(completeAddress =>
-          completeAddress.address.equals(dao.recipient),
-        );
-        const completeAddress = completeAddresses[completeAddressIndex];
-        if (completeAddress === undefined) {
-          throw new Error(`Cannot find complete address for recipient ${dao.recipient.toString()}`);
-        }
-        recipient = completeAddress.address;
-      }
-      return new UniqueNote(dao.note, recipient, dao.contractAddress, dao.storageSlot, dao.txHash, dao.noteNonce);
-    });
-    return Promise.all(extendedNotes);
-  }
-
-  public async getBlock(blockNumber: number): Promise<L2Block | undefined> {
-    // If a negative block number is provided the current block number is fetched.
-    if (blockNumber < 0) {
-      blockNumber = await this.node.getBlockNumber();
-    }
-    return await this.node.getBlock(blockNumber);
-  }
+  /**
+   * A debugging utility to get notes based on the provided filter.
+   *
+   * Note that this should not be used in production code because the structure of notes is considered to be
+   * an implementation detail of contracts. This is only meant to be used for debugging purposes. If you need to obtain
+   * note-related information in production code, please implement a custom utility function on your contract and call
+   * that function instead (e.g. `get_balance(owner: AztecAddress) -> u128` utility function on a Token contract).
+   *
+   * @param filter - The filter to apply to the notes.
+   * @returns The requested notes.
+   */
+  public async getNotes(filter: NotesFilter): Promise<NoteDao[]> {
+    // We need to manually trigger private state sync to have a guarantee that all the notes are available.
+    const call = await this.#getFunctionCall('sync_private_state', [], filter.contractAddress);
+    await this.simulateUtility(call);
 
-  public async getCurrentBaseFees(): Promise<GasFees> {
-    return await this.node.getCurrentBaseFees();
+    return this.noteDataProvider.getNotes(filter);
   }
 
-  public proveTx(
-    txRequest: TxExecutionRequest,
-    privateExecutionResult?: PrivateExecutionResult,
-  ): Promise<TxProvingResult> {
+  /**
+   * 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.
+   */
+  public proveTx(txRequest: TxExecutionRequest): Promise<TxProvingResult> {
+    let privateExecutionResult: PrivateExecutionResult;
     // We disable proving concurrently mostly out of caution, since it accesses some of our stores. Proving is so
     // computationally demanding that it'd be rare for someone to try to do it concurrently regardless.
     return this.#putInJobQueue(async () => {
       const totalTimer = new Timer();
       try {
-        let syncTime: number | undefined;
-        let contractFunctionSimulator: ContractFunctionSimulator | undefined;
-        if (!privateExecutionResult) {
-          const syncTimer = new Timer();
-          await this.synchronizer.sync();
-          syncTime = syncTimer.ms();
-          contractFunctionSimulator = this.#getSimulatorForTx();
-          privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest);
-        }
+        const syncTimer = new Timer();
+        await this.synchronizer.sync();
+        const syncTime = syncTimer.ms();
+        const contractFunctionSimulator = this.#getSimulatorForTx();
+        privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest);
+
         const {
           publicInputs,
-          clientIvcProof,
+          chonkProof,
           executionSteps,
           timings: { proving } = {},
         } = await this.#prove(txRequest, this.proofCreator, privateExecutionResult, {
@@ -742,16 +729,38 @@ export class PXEService implements PXE {
         };
 
         this.log.debug(`Proving completed in ${totalTime}ms`, { timings });
-        return new TxProvingResult(privateExecutionResult, publicInputs, clientIvcProof!, {
+
+        const txProvingResult = new TxProvingResult(privateExecutionResult, publicInputs, chonkProof!, {
           timings,
           nodeRPCCalls: contractFunctionSimulator?.getStats().nodeRPCCalls,
         });
+
+        const preTagsUsedInTheTx = privateExecutionResult.entrypoint.preTags;
+        if (preTagsUsedInTheTx.length > 0) {
+          await this.taggingDataProvider.setLastUsedIndexesAsSender(preTagsUsedInTheTx);
+          this.log.debug(`Stored used pre tags as sender for the tx`, {
+            preTagsUsedInTheTx,
+          });
+        } else {
+          this.log.debug(`No pre tags used in the tx`);
+        }
+
+        return txProvingResult;
       } catch (err: any) {
         throw this.#contextualizeError(err, inspect(txRequest), inspect(privateExecutionResult));
       }
     });
   }
 
+  /**
+   * 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`.
+   */
   public profileTx(
     txRequest: TxExecutionRequest,
     profileMode: 'full' | 'execution-steps' | 'gates',
@@ -824,7 +833,29 @@ export class PXEService implements PXE {
     });
   }
 
-  // TODO(#7456) Prevent msgSender being defined here for the first call
+  /**
+   * 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.
+   *
+   * TODO(#7456) Prevent msgSender being defined here for the first call
+   */
   public simulateTx(
     txRequest: TxExecutionRequest,
     simulatePublic: boolean,
@@ -869,10 +900,9 @@ export class PXEService implements PXE {
 
         if (skipKernels) {
           // According to the protocol rules, the nonce generator for the note hashes
-          // can either be the first nullifier in the tx or the hash of the initial tx request
-          // if there are none.
+          // can either be the first nullifier in the tx or the protocol nullifier if there are none.
           const nonceGenerator = privateExecutionResult.firstNullifier.equals(Fr.ZERO)
-            ? await txRequest.toTxRequest().hash()
+            ? await computeProtocolNullifier(await txRequest.toTxRequest().hash())
             : privateExecutionResult.firstNullifier;
           ({ publicInputs, executionSteps } = await generateSimulatedProvingResult(
             privateExecutionResult,
@@ -961,25 +991,18 @@ export class PXEService implements PXE {
     });
   }
 
-  public async sendTx(tx: Tx): Promise<TxHash> {
-    const txHash = tx.getTxHash();
-    if (await this.node.getTxEffect(txHash)) {
-      throw new Error(`A settled tx with equal hash ${txHash.toString()} exists.`);
-    }
-    this.log.debug(`Sending transaction ${txHash}`);
-    await this.node.sendTx(tx).catch(err => {
-      throw this.#contextualizeError(err, inspect(tx));
-    });
-    this.log.info(`Sent transaction ${txHash}`);
-    return txHash;
-  }
-
+  /**
+   * Simulate the execution of a contract utility function.
+   *
+   * @param call - The function call containing the function details, arguments, and target contract address.
+   * @param authwits - (Optional) The authentication witnesses required for the function 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.
+   */
   public simulateUtility(
-    functionName: string,
-    args: any[],
-    to: AztecAddress,
+    call: FunctionCall,
     authwits?: AuthWitness[],
-    _from?: AztecAddress,
     scopes?: AztecAddress[],
   ): Promise<UtilitySimulationResult> {
     // We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
@@ -991,21 +1014,14 @@ export class PXEService implements PXE {
         const syncTimer = new Timer();
         await this.synchronizer.sync();
         const syncTime = syncTimer.ms();
-        // TODO - Should check if `from` has the permission to call the view function.
-        const functionCall = await this.#getFunctionCall(functionName, args, to);
         const functionTimer = new Timer();
         const contractFunctionSimulator = this.#getSimulatorForTx();
-        const executionResult = await this.#simulateUtility(
-          contractFunctionSimulator,
-          functionCall,
-          authwits ?? [],
-          scopes,
-        );
+        const executionResult = await this.#simulateUtility(contractFunctionSimulator, call, authwits ?? [], scopes);
         const functionTime = functionTimer.ms();
 
         const totalTime = totalTimer.ms();
 
-        const perFunction = [{ functionName, time: functionTime }];
+        const perFunction = [{ functionName: call.name, time: functionTime }];
 
         const timings: SimulationTimings = {
           total: totalTime,
@@ -1017,118 +1033,50 @@ export class PXEService implements PXE {
         const simulationStats = contractFunctionSimulator.getStats();
         return { result: executionResult, stats: { timings, nodeRPCCalls: simulationStats.nodeRPCCalls } };
       } catch (err: any) {
+        const { to, name, args } = call;
         const stringifiedArgs = args.map(arg => arg.toString()).join(', ');
         throw this.#contextualizeError(
           err,
-          `simulateUtility ${to}:${functionName}(${stringifiedArgs})`,
+          `simulateUtility ${to}:${name}(${stringifiedArgs})`,
           `scopes=${scopes?.map(s => s.toString()).join(', ') ?? 'undefined'}`,
         );
       }
     });
   }
 
-  public async getNodeInfo(): Promise<NodeInfo> {
-    // This assumes we're connected to a single node, so we cache the info to avoid repeated calls.
-    // Load balancers and a myriad other configurations can break this assumption, so review this!
-    // Temporary measure to avoid hammering full nodes with requests on testnet.
-    if (!this.#nodeInfo) {
-      const [nodeVersion, rollupVersion, chainId, enr, contractAddresses, protocolContractAddresses] =
-        await Promise.all([
-          this.node.getNodeVersion(),
-          this.node.getVersion(),
-          this.node.getChainId(),
-          this.node.getEncodedEnr(),
-          this.node.getL1ContractAddresses(),
-          this.node.getProtocolContractAddresses(),
-        ]);
-
-      this.#nodeInfo = {
-        nodeVersion,
-        l1ChainId: chainId,
-        rollupVersion,
-        enr,
-        l1ContractAddresses: contractAddresses,
-        protocolContractAddresses: protocolContractAddresses,
-      };
-    }
-
-    return this.#nodeInfo;
-  }
-
-  public getPXEInfo(): Promise<PXEInfo> {
-    return Promise.resolve({
-      pxeVersion: this.packageVersion,
-      protocolContractAddresses: {
-        classRegistry: ProtocolContractAddress.ContractClassRegistry,
-        feeJuice: ProtocolContractAddress.FeeJuice,
-        instanceRegistry: ProtocolContractAddress.ContractInstanceRegistry,
-        multiCallEntrypoint: ProtocolContractAddress.MultiCallEntrypoint,
-      },
-    });
-  }
-
-  public async getPrivateEvents<T>(
-    contractAddress: AztecAddress,
-    eventMetadataDef: EventMetadataDefinition,
-    from: number,
-    numBlocks: number,
-    recipients: AztecAddress[],
-  ): Promise<T[]> {
-    if (recipients.length === 0) {
-      throw new Error('Recipients are required to get private events');
-    }
-
-    this.log.verbose(`Getting private events for ${contractAddress.toString()} from ${from} to ${from + numBlocks}`);
-
+  /**
+   * Returns the private events given search parameters.
+   * @param eventSelector - Event selector to search for.
+   * @param filter
+   *  contractAddress - The address of the contract to get events from. Required.
+   *  scopes - One or more event scope addresses to filter by. Required.
+   *  fromBlock - The block number to search from (inclusive). Optional. If provided, it must be >= 0.
+   *    Defaults to 0.
+   *    If toBlock is defined but fromBlock is not, fromBlock defaults to toBlock - 1.
+   *  toBlock - The block number to search up to (exclusive). Optional. If provided, it must be > 0.
+   *    Defaults to the latest known block to PXE + 1.
+   * @returns - The packed events with block and tx metadata.
+   */
+  public async getPrivateEvents(
+    eventSelector: EventSelector,
+    filter: PrivateEventFilter,
+  ): Promise<PackedPrivateEvent[]> {
     // We need to manually trigger private state sync to have a guarantee that all the events are available.
-    await this.simulateUtility('sync_private_state', [], contractAddress);
-
-    const events = await this.privateEventDataProvider.getPrivateEvents(
-      contractAddress,
-      from,
-      numBlocks,
-      recipients,
-      eventMetadataDef.eventSelector,
-    );
-
-    const decodedEvents = events.map((event: Fr[]): T => decodeFromAbi([eventMetadataDef.abiType], event) as T);
-
-    return decodedEvents;
-  }
-
-  async getPublicEvents<T>(eventMetadataDef: EventMetadataDefinition, from: number, limit: number): Promise<T[]> {
-    const { logs } = await this.node.getPublicLogs({
-      fromBlock: from,
-      toBlock: from + limit,
-    });
+    const call = await this.#getFunctionCall('sync_private_state', [], filter.contractAddress);
+    await this.simulateUtility(call);
 
-    const decodedEvents = logs
-      .map(log => {
-        // +1 for the event selector
-        const expectedLength = eventMetadataDef.fieldNames.length + 1;
-        if (log.log.emittedLength !== expectedLength) {
-          throw new Error(
-            `Something is weird here, we have matching EventSelectors, but the actual payload has mismatched length. Expected ${expectedLength}. Got ${log.log.emittedLength}.`,
-          );
-        }
-
-        const logFields = log.log.getEmittedFields();
-        // We are assuming here that event logs are the last 4 bytes of the event. This is not enshrined but is a function of aztec.nr raw log emission.
-        if (!EventSelector.fromField(logFields[logFields.length - 1]).equals(eventMetadataDef.eventSelector)) {
-          return undefined;
-        }
-
-        return decodeFromAbi([eventMetadataDef.abiType], log.log.fields) as T;
-      })
-      .filter(log => log !== undefined) as T[];
+    const sanitizedFilter = await new PrivateEventFilterValidator(this.syncDataProvider).validate(filter);
 
-    return decodedEvents;
-  }
+    this.log.error(
+      `Getting private events for ${sanitizedFilter.contractAddress.toString()} from ${sanitizedFilter.fromBlock} to ${sanitizedFilter.toBlock}`,
+    );
 
-  async resetNoteSyncData() {
-    return await this.taggingDataProvider.resetNoteSyncData();
+    return this.privateEventDataProvider.getPrivateEvents(eventSelector, sanitizedFilter);
   }
 
+  /**
+   * Stops the PXE's job queue.
+   */
   public stop(): Promise<void> {
     return this.jobQueue.end();
   }