@aztec/pxe 1.2.1 → 2.0.0-nightly.20250813

package/src/contract_function_simulator/oracle/utility_execution_oracle.ts

@@ -32,23 +32,27 @@ export class UtilityExecutionOracle extends TypedOracle {
     super();
   }
 
-  public override getBlockNumber(): Promise<number> {
+  public override utilityGetRandomField(): Fr {
+    return Fr.random();
+  }
+
+  public override utilityGetBlockNumber(): Promise<number> {
     return this.executionDataProvider.getBlockNumber();
   }
 
-  public override getTimestamp(): Promise<UInt64> {
+  public override utilityGetTimestamp(): Promise<UInt64> {
     return this.executionDataProvider.getTimestamp();
   }
 
-  public override getContractAddress(): Promise<AztecAddress> {
+  public override utilityGetContractAddress(): Promise<AztecAddress> {
     return Promise.resolve(this.contractAddress);
   }
 
-  public override getChainId(): Promise<Fr> {
+  public override utilityGetChainId(): Promise<Fr> {
     return Promise.resolve(this.executionDataProvider.getChainId().then(id => new Fr(id)));
   }
 
-  public override getVersion(): Promise<Fr> {
+  public override utilityGetVersion(): Promise<Fr> {
     return Promise.resolve(this.executionDataProvider.getVersion().then(v => new Fr(v)));
   }
 
@@ -58,7 +62,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @returns A Promise that resolves to nullifier keys.
    * @throws If the keys are not registered in the key store.
    */
-  public override getKeyValidationRequest(pkMHash: Fr): Promise<KeyValidationRequest> {
+  public override utilityGetKeyValidationRequest(pkMHash: Fr): Promise<KeyValidationRequest> {
     return this.executionDataProvider.getKeyValidationRequest(pkMHash, this.contractAddress);
   }
 
@@ -69,7 +73,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param leafValue - The leaf value
    * @returns The index and sibling path concatenated [index, sibling_path]
    */
-  public override getMembershipWitness(blockNumber: number, treeId: MerkleTreeId, leafValue: Fr): Promise<Fr[]> {
+  public override utilityGetMembershipWitness(blockNumber: number, treeId: MerkleTreeId, leafValue: Fr): Promise<Fr[]> {
     return this.executionDataProvider.getMembershipWitness(blockNumber, treeId, leafValue);
   }
 
@@ -79,7 +83,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param nullifier - Nullifier we try to find witness for.
    * @returns The nullifier membership witness (if found).
    */
-  public override async getNullifierMembershipWitness(
+  public override async utilityGetNullifierMembershipWitness(
     blockNumber: number,
     nullifier: Fr,
   ): Promise<NullifierMembershipWitness | undefined> {
@@ -95,7 +99,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * list structure" of leaves and proving that a lower nullifier is pointing to a bigger next value than the nullifier
    * we are trying to prove non-inclusion for.
    */
-  public override async getLowNullifierMembershipWitness(
+  public override async utilityGetLowNullifierMembershipWitness(
     blockNumber: number,
     nullifier: Fr,
   ): Promise<NullifierMembershipWitness | undefined> {
@@ -108,7 +112,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param leafSlot - The slot of the public data tree to get the witness for.
    * @returns - The witness
    */
-  public override async getPublicDataWitness(
+  public override async utilityGetPublicDataWitness(
     blockNumber: number,
     leafSlot: Fr,
   ): Promise<PublicDataWitness | undefined> {
@@ -120,7 +124,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param blockNumber - The number of a block of which to get the block header.
    * @returns Block extracted from a block with block number `blockNumber`.
    */
-  public override async getBlockHeader(blockNumber: number): Promise<BlockHeader | undefined> {
+  public override async utilityGetBlockHeader(blockNumber: number): Promise<BlockHeader | undefined> {
     const block = await this.executionDataProvider.getBlock(blockNumber);
     if (!block) {
       return undefined;
@@ -134,7 +138,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @returns A complete address associated with the input address.
    * @throws An error if the account is not registered in the database.
    */
-  public override getCompleteAddress(account: AztecAddress): Promise<CompleteAddress> {
+  public override utilityGetCompleteAddress(account: AztecAddress): Promise<CompleteAddress> {
     return this.executionDataProvider.getCompleteAddress(account);
   }
 
@@ -143,7 +147,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param address - Address.
    * @returns A contract instance.
    */
-  public override getContractInstance(address: AztecAddress): Promise<ContractInstance> {
+  public override utilityGetContractInstance(address: AztecAddress): Promise<ContractInstance> {
     return this.executionDataProvider.getContractInstance(address);
   }
 
@@ -153,7 +157,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param messageHash - Hash of the message to authenticate.
    * @returns Authentication witness for the requested message hash.
    */
-  public override getAuthWitness(messageHash: Fr): Promise<Fr[] | undefined> {
+  public override utilityGetAuthWitness(messageHash: Fr): Promise<Fr[] | undefined> {
     return Promise.resolve(this.authWitnesses.find(w => w.requestHash.equals(messageHash))?.witness);
   }
 
@@ -178,7 +182,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param status - The status of notes to fetch.
    * @returns Array of note data.
    */
-  public override async getNotes(
+  public override async utilityGetNotes(
     storageSlot: Fr,
     numSelects: number,
     selectByIndexes: number[],
@@ -215,7 +219,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param innerNullifier - The inner nullifier.
    * @returns A boolean indicating whether the nullifier exists in the tree or not.
    */
-  public override async checkNullifierExists(innerNullifier: Fr) {
+  public override async utilityCheckNullifierExists(innerNullifier: Fr) {
     const nullifier = await siloNullifier(this.contractAddress, innerNullifier!);
     const index = await this.executionDataProvider.getNullifierIndex(nullifier);
     return index !== undefined;
@@ -229,7 +233,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @dev Contract address and secret are only used to compute the nullifier to get non-nullified messages
    * @returns The l1 to l2 membership witness (index of message in the tree and sibling path).
    */
-  public override async getL1ToL2MembershipWitness(contractAddress: AztecAddress, messageHash: Fr, secret: Fr) {
+  public override async utilityGetL1ToL2MembershipWitness(contractAddress: AztecAddress, messageHash: Fr, secret: Fr) {
     return await this.executionDataProvider.getL1ToL2MembershipWitness(contractAddress, messageHash, secret);
   }
 
@@ -240,7 +244,7 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param blockNumber - The block number to read storage at.
    * @param numberOfElements - Number of elements to read from the starting storage slot.
    */
-  public override async storageRead(
+  public override async utilityStorageRead(
     contractAddress: AztecAddress,
     startStorageSlot: Fr,
     blockNumber: number,
@@ -259,7 +263,7 @@ export class UtilityExecutionOracle extends TypedOracle {
     return values;
   }
 
-  public override debugLog(message: string, fields: Fr[]): void {
+  public override utilityDebugLog(message: string, fields: Fr[]): void {
     this.log.verbose(`${applyStringFormatting(message, fields)}`, { module: `${this.log.module}:debug_log` });
   }
 
@@ -271,20 +275,20 @@ export class UtilityExecutionOracle extends TypedOracle {
    * @param recipient - The address receiving the note
    * @returns A tagging secret that can be used to tag notes.
    */
-  public override async getIndexedTaggingSecretAsSender(
+  public override async utilityGetIndexedTaggingSecretAsSender(
     sender: AztecAddress,
     recipient: AztecAddress,
   ): Promise<IndexedTaggingSecret> {
     return await this.executionDataProvider.getIndexedTaggingSecretAsSender(this.contractAddress, sender, recipient);
   }
 
-  public override async fetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr) {
+  public override async utilityFetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr) {
     await this.executionDataProvider.syncTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes);
 
     await this.executionDataProvider.removeNullifiedNotes(this.contractAddress);
   }
 
-  public override async validateEnqueuedNotesAndEvents(
+  public override async utilityValidateEnqueuedNotesAndEvents(
     contractAddress: AztecAddress,
     noteValidationRequestsArrayBaseSlot: Fr,
     eventValidationRequestsArrayBaseSlot: Fr,
@@ -301,7 +305,7 @@ export class UtilityExecutionOracle extends TypedOracle {
     );
   }
 
-  public override async bulkRetrieveLogs(
+  public override async utilityBulkRetrieveLogs(
     contractAddress: AztecAddress,
     logRetrievalRequestsArrayBaseSlot: Fr,
     logRetrievalResponsesArrayBaseSlot: Fr,
@@ -318,7 +322,7 @@ export class UtilityExecutionOracle extends TypedOracle {
     );
   }
 
-  public override storeCapsule(contractAddress: AztecAddress, slot: Fr, capsule: Fr[]): Promise<void> {
+  public override utilityStoreCapsule(contractAddress: AztecAddress, slot: Fr, capsule: Fr[]): Promise<void> {
     if (!contractAddress.equals(this.contractAddress)) {
       // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
       throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -326,7 +330,7 @@ export class UtilityExecutionOracle extends TypedOracle {
     return this.executionDataProvider.storeCapsule(this.contractAddress, slot, capsule);
   }
 
-  public override async loadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null> {
+  public override async utilityLoadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null> {
     if (!contractAddress.equals(this.contractAddress)) {
       // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
       throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -338,7 +342,7 @@ export class UtilityExecutionOracle extends TypedOracle {
     );
   }
 
-  public override deleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void> {
+  public override utilityDeleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void> {
     if (!contractAddress.equals(this.contractAddress)) {
       // TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
       throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
@@ -346,7 +350,7 @@ export class UtilityExecutionOracle extends TypedOracle {
     return this.executionDataProvider.deleteCapsule(this.contractAddress, slot);
   }
 
-  public override copyCapsule(
+  public override utilityCopyCapsule(
     contractAddress: AztecAddress,
     srcSlot: Fr,
     dstSlot: Fr,
@@ -360,16 +364,16 @@ export class UtilityExecutionOracle extends TypedOracle {
   }
 
   // TODO(#11849): consider replacing this oracle with a pure Noir implementation of aes decryption.
-  public override aes128Decrypt(ciphertext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer> {
+  public override utilityAes128Decrypt(ciphertext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer> {
     const aes128 = new Aes128();
     return aes128.decryptBufferCBC(ciphertext, iv, symKey);
   }
 
-  public override getSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
+  public override utilityGetSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
     return this.executionDataProvider.getSharedSecret(address, ephPk);
   }
 
-  public override emitOffchainEffect(_data: Fr[]): Promise<void> {
+  public override utilityEmitOffchainEffect(_data: Fr[]): Promise<void> {
     return Promise.reject(new Error('Cannot emit offchain effects from a utility function'));
   }
 }

package/src/contract_function_simulator/pxe_oracle_interface.ts

@@ -75,7 +75,7 @@ export class PXEOracleInterface implements ExecutionDataProvider {
     if (!completeAddress) {
       throw new Error(
         `No public key registered for address ${account}.
-        Register it by calling pxe.registerAccount(...).\nSee docs for context: https://docs.aztec.network/developers/reference/debugging/aztecnr-errors#simulation-error-no-public-key-registered-for-address-0x0-register-it-by-calling-pxeregisterrecipient-or-pxeregisteraccount`,
+        Register it by calling pxe.addAccount(...).\nSee docs for context: https://docs.aztec.network/developers/reference/debugging/aztecnr-errors#simulation-error-no-public-key-registered-for-address-0x0-register-it-by-calling-pxeregisterrecipient-or-pxeregisteraccount`,
       );
     }
     return completeAddress;
@@ -500,6 +500,11 @@ export class PXEOracleInterface implements ExecutionDataProvider {
 
         // Fetch the private logs for the tags and iterate over them
         const logsByTags = await this.#getPrivateLogsByTags(tagsForTheWholeWindow);
+        this.log.debug(`Found ${logsByTags.filter(logs => logs.length > 0).length} logs as recipient ${recipient}`, {
+          recipient,
+          contractName,
+          contractAddress,
+        });
 
         for (let logIndex = 0; logIndex < logsByTags.length; logIndex++) {
           const logsByTag = logsByTags[logIndex];
@@ -520,13 +525,6 @@ export class PXEOracleInterface implements ExecutionDataProvider {
             const secretCorrespondingToLog = secretsForTheWholeWindow[logIndex];
             const initialIndex = initialIndexesMap[secretCorrespondingToLog.appTaggingSecret.toString()];
 
-            this.log.debug(`Found ${logsByTags.length} logs as recipient ${recipient}`, {
-              recipient,
-              secret: secretCorrespondingToLog.appTaggingSecret,
-              contractName,
-              contractAddress,
-            });
-
             if (
               secretCorrespondingToLog.index >= initialIndex &&
               (newLargestIndexMapForIteration[secretCorrespondingToLog.appTaggingSecret.toString()] === undefined ||

package/src/entrypoints/server/utils.ts

@@ -17,6 +17,11 @@ import { PXEService } from '../../pxe_service/pxe_service.js';
 import { PXE_DATA_SCHEMA_VERSION } from '../../storage/index.js';
 import type { PXECreationOptions } from '../pxe_creation_options.js';
 
+type PXEConfigWithoutDefaults = Omit<
+  PXEServiceConfig,
+  'l1Contracts' | 'l1ChainId' | 'l2BlockBatchSize' | 'rollupVersion'
+>;
+
 /**
  * Create and start an PXEService instance with the given AztecNode and config.
  *
@@ -27,7 +32,7 @@ import type { PXECreationOptions } from '../pxe_creation_options.js';
  */
 export function createPXEService(
   aztecNode: AztecNode,
-  config: PXEServiceConfig,
+  config: PXEConfigWithoutDefaults,
   options: PXECreationOptions = { loggers: {} },
 ) {
   const simulator = new WASMSimulator();
@@ -50,7 +55,7 @@ export function createPXEService(
 export async function createPXEServiceWithSimulator(
   aztecNode: AztecNode,
   simulator: CircuitSimulator,
-  config: PXEServiceConfig,
+  config: PXEConfigWithoutDefaults,
   options: PXECreationOptions = { loggers: {} },
 ) {
   const logSuffix =
@@ -61,10 +66,12 @@ export async function createPXEServiceWithSimulator(
       : options.useLogSuffix;
   const loggers = options.loggers ?? {};
 
-  const l1Contracts = await aztecNode.getL1ContractAddresses();
-  const configWithContracts = {
+  const { l1ChainId, l1ContractAddresses: l1Contracts, rollupVersion } = await aztecNode.getNodeInfo();
+  const configWithContracts: PXEServiceConfig = {
     ...config,
     l1Contracts,
+    l1ChainId,
+    rollupVersion,
     l2BlockBatchSize: 50,
   };
 
@@ -91,13 +98,17 @@ export async function createPXEServiceWithSimulator(
     prover,
     simulator,
     protocolContractsProvider,
-    config,
+    configWithContracts,
     pxeLogger,
   );
   return pxe;
 }
 
-function createProver(config: PXEServiceConfig, simulator: CircuitSimulator, logger?: Logger) {
+function createProver(
+  config: Pick<PXEServiceConfig, 'bbBinaryPath' | 'bbWorkingDirectory'>,
+  simulator: CircuitSimulator,
+  logger?: Logger,
+) {
   if (!config.bbBinaryPath || !config.bbWorkingDirectory) {
     return new BBWASMBundlePrivateKernelProver(simulator, 16, logger);
   } else {