@aztec/pxe 0.76.4 → 0.77.0-testnet-ignition.21

package/src/simulator_oracle/index.ts

@@ -1,57 +1,49 @@
 import {
-  type AztecNode,
-  type FunctionCall,
-  type InBlock,
-  L1NotePayload,
-  type L2Block,
-  type L2BlockNumber,
-  MerkleTreeId,
-  Note,
-  type NoteStatus,
-  type NullifierMembershipWitness,
-  type PublicDataWitness,
-  TxHash,
-  type TxScopedL2Log,
-  getNonNullifiedL1ToL2MessageWitness,
-} from '@aztec/circuit-types';
-import {
-  type AztecAddress,
-  type BlockHeader,
-  type CompleteAddress,
-  type ContractInstance,
-  Fr,
-  FunctionSelector,
-  IndexedTaggingSecret,
-  type KeyValidationRequest,
   type L1_TO_L2_MSG_TREE_HEIGHT,
   MAX_NOTE_HASHES_PER_TX,
   PRIVATE_LOG_SIZE_IN_FIELDS,
-  PrivateLog,
-  PublicLog,
-  computeAddressSecret,
-  computeTaggingSecretPoint,
-} from '@aztec/circuits.js';
-import { computeUniqueNoteHash, siloNoteHash, siloNullifier } from '@aztec/circuits.js/hash';
+  PUBLIC_LOG_DATA_SIZE_IN_FIELDS,
+} from '@aztec/constants';
+import { timesParallel } from '@aztec/foundation/collection';
+import { poseidon2Hash } from '@aztec/foundation/crypto';
+import { Fr } from '@aztec/foundation/fields';
+import { createLogger } from '@aztec/foundation/log';
+import { BufferReader } from '@aztec/foundation/serialize';
+import type { KeyStore } from '@aztec/key-store';
+import type { AcirSimulator, DBOracle, SimulationProvider } from '@aztec/simulator/client';
+import { MessageLoadOracleInputs } from '@aztec/simulator/client';
 import {
   type FunctionArtifact,
+  FunctionCall,
+  FunctionSelector,
   FunctionType,
   NoteSelector,
   encodeArguments,
   getFunctionArtifact,
-} from '@aztec/foundation/abi';
-import { timesParallel } from '@aztec/foundation/collection';
-import { poseidon2Hash } from '@aztec/foundation/crypto';
-import { createLogger } from '@aztec/foundation/log';
-import { type KeyStore } from '@aztec/key-store';
+} from '@aztec/stdlib/abi';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { InBlock, L2Block, L2BlockNumber } from '@aztec/stdlib/block';
+import type { CompleteAddress, ContractInstance } from '@aztec/stdlib/contract';
+import { computeUniqueNoteHash, siloNoteHash, siloNullifier } from '@aztec/stdlib/hash';
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+import type { KeyValidationRequest } from '@aztec/stdlib/kernel';
+import { computeAddressSecret, computeTaggingSecretPoint } from '@aztec/stdlib/keys';
 import {
-  type AcirSimulator,
-  type DBOracle,
-  MessageLoadOracleInputs,
-  type SimulationProvider,
-} from '@aztec/simulator/client';
+  IndexedTaggingSecret,
+  L1NotePayload,
+  LogWithTxData,
+  PrivateLog,
+  PublicLog,
+  TxScopedL2Log,
+} from '@aztec/stdlib/logs';
+import { getNonNullifiedL1ToL2MessageWitness } from '@aztec/stdlib/messaging';
+import { Note, type NoteStatus } from '@aztec/stdlib/note';
+import { MerkleTreeId, type NullifierMembershipWitness, PublicDataWitness } from '@aztec/stdlib/trees';
+import type { BlockHeader } from '@aztec/stdlib/tx';
+import { TxHash } from '@aztec/stdlib/tx';
 
 import { ContractDataOracle } from '../contract_data_oracle/index.js';
-import { type PxeDatabase } from '../database/index.js';
+import type { PxeDatabase } from '../database/index.js';
 import { NoteDao } from '../database/note_dao.js';
 import { getOrderedNoteItems } from '../note_decryption_utils/add_public_values_to_payload.js';
 import { getAcirSimulator } from '../simulator/index.js';
@@ -79,7 +71,7 @@ export class SimulatorOracle implements DBOracle {
     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/reference/common_errors/aztecnr-errors#simulation-error-no-public-key-registered-for-address-0x0-register-it-by-calling-pxeregisterrecipient-or-pxeregisteraccount`,
+        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`,
       );
     }
     return completeAddress;
@@ -134,7 +126,7 @@ export class SimulatorOracle implements DBOracle {
     functionName: string,
   ): Promise<FunctionArtifact | undefined> {
     const instance = await this.contractDataOracle.getContractInstance(contractAddress);
-    const artifact = await this.contractDataOracle.getContractArtifact(instance.contractClassId);
+    const artifact = await this.contractDataOracle.getContractArtifact(instance.currentContractClassId);
     return artifact && getFunctionArtifact(artifact, functionName);
   }
 
@@ -699,8 +691,45 @@ export class SimulatorOracle implements DBOracle {
     });
   }
 
+  public async getLogByTag(tag: Fr): Promise<LogWithTxData | null> {
+    const logs = await this.aztecNode.getLogsByTags([tag]);
+    const logsForTag = logs[0];
+
+    this.log.debug(`Got ${logsForTag.length} logs for tag ${tag}`);
+
+    if (logsForTag.length == 0) {
+      return null;
+    } else if (logsForTag.length > 1) {
+      // TODO(#11627): handle this case
+      throw new Error(
+        `Got ${logsForTag.length} logs for tag ${tag}. getLogByTag currently only supports a single log per tag`,
+      );
+    }
+
+    const log = logsForTag[0];
+
+    // getLogsByTag doesn't have all of the information that we need (notably note hashes and the first nullifier), so
+    // we need to make a second call to the node for `getTxEffect`.
+    // TODO(#9789): bundle this information in the `getLogsByTag` call.
+    const txEffect = await this.aztecNode.getTxEffect(log.txHash);
+    if (txEffect == undefined) {
+      throw new Error(`Unexpected: failed to retrieve tx effects for tx ${log.txHash} which is known to exist`);
+    }
+
+    const reader = BufferReader.asReader(log.logData);
+    const logArray = reader.readArray(PUBLIC_LOG_DATA_SIZE_IN_FIELDS, Fr);
+
+    // Public logs always take up all available fields by padding with zeroes, and the length of the originally emitted
+    // log is lost. Until this is improved, we simply remove all of the zero elements (which are expected to be at the
+    // end).
+    // TODO(#11636): use the actual log length.
+    const trimmedLog = logArray.filter(x => !x.isZero());
+
+    return new LogWithTxData(trimmedLog, log.txHash.hash, txEffect.data.noteHashes, txEffect.data.nullifiers[0]);
+  }
+
   public async removeNullifiedNotes(contractAddress: AztecAddress) {
-    this.log.verbose('Removing nullified notes', { contract: contractAddress });
+    this.log.verbose('Searching for nullifiers of known notes', { contract: contractAddress });
 
     for (const recipient of await this.keyStore.getAccounts()) {
       const currentNotesForRecipient = await this.db.getNotes({ contractAddress, owner: recipient });
@@ -775,7 +804,7 @@ export class SimulatorOracle implements DBOracle {
       receipt.blockHash!.toString(),
       uniqueNoteHashTreeIndex,
       await recipient.toAddressPoint(),
-      NoteSelector.empty(), // todo: remove
+      NoteSelector.empty(), // TODO(#12013): remove
     );
   }
 
@@ -798,10 +827,11 @@ export class SimulatorOracle implements DBOracle {
       );
     }
 
+    const selector = await FunctionSelector.fromNameAndParameters(artifact);
     const execRequest: FunctionCall = {
       name: artifact.name,
       to: contractAddress,
-      selector: await FunctionSelector.fromNameAndParameters(artifact),
+      selector,
       type: FunctionType.UNCONSTRAINED,
       isStatic: artifact.isStatic,
       args: encodeArguments(artifact, [
@@ -819,8 +849,8 @@ export class SimulatorOracle implements DBOracle {
       getAcirSimulator(this.db, this.aztecNode, this.keyStore, this.simulationProvider, this.contractDataOracle)
     ).runUnconstrained(
       execRequest,
-      artifact,
       contractAddress,
+      selector,
       [], // empty scope as this call should not require access to private information
     );
   }

package/src/simulator_oracle/tagging_utils.ts

@@ -1,4 +1,5 @@
-import { type Fr, IndexedTaggingSecret } from '@aztec/circuits.js';
+import type { Fr } from '@aztec/foundation/fields';
+import { IndexedTaggingSecret } from '@aztec/stdlib/logs';
 
 // Half the size of the window we slide over the tagging secret indexes.
 export const WINDOW_HALF_SIZE = 10;

package/src/synchronizer/synchronizer.ts

@@ -1,15 +1,11 @@
-import {
-  type AztecNode,
-  L2BlockStream,
-  type L2BlockStreamEvent,
-  type L2BlockStreamEventHandler,
-} from '@aztec/circuit-types';
-import { INITIAL_L2_BLOCK_NUM } from '@aztec/circuits.js';
+import { INITIAL_L2_BLOCK_NUM } from '@aztec/constants';
 import { type Logger, createLogger } from '@aztec/foundation/log';
-import { type L2TipsStore } from '@aztec/kv-store/stores';
+import type { L2TipsStore } from '@aztec/kv-store/stores';
+import { L2BlockStream, type L2BlockStreamEvent, type L2BlockStreamEventHandler } from '@aztec/stdlib/block';
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
 
-import { type PXEConfig } from '../config/index.js';
-import { type PxeDatabase } from '../database/index.js';
+import type { PXEConfig } from '../config/index.js';
+import type { PxeDatabase } from '../database/index.js';
 
 /**
  * The Synchronizer class manages the synchronization with the aztec node, allowing PXE to retrieve the
@@ -20,6 +16,7 @@ import { type PxeDatabase } from '../database/index.js';
 export class Synchronizer implements L2BlockStreamEventHandler {
   private initialSyncBlockNumber = INITIAL_L2_BLOCK_NUM - 1;
   private log: Logger;
+  private isSyncing: Promise<void> | undefined;
   protected readonly blockStream: L2BlockStream;
 
   constructor(
@@ -66,7 +63,12 @@ export class Synchronizer implements L2BlockStreamEventHandler {
         // block number in which each index is used it's all we can do.
         await this.db.resetNoteSyncData();
         // Update the header to the last block.
-        await this.db.setHeader(await this.node.getBlockHeader(event.blockNumber));
+        const newHeader = await this.node.getBlockHeader(event.blockNumber);
+        if (!newHeader) {
+          this.log.error(`Block header not found for block number ${event.blockNumber} during chain prune`);
+        } else {
+          await this.db.setHeader(newHeader);
+        }
         break;
       }
     }
@@ -77,6 +79,23 @@ export class Synchronizer implements L2BlockStreamEventHandler {
    * recent data (e.g. notes), and handling any reorgs that might have occurred.
    */
   public async sync() {
+    if (this.isSyncing !== undefined) {
+      this.log.debug(`Waiting for the ongoing sync to finish`);
+      await this.isSyncing;
+      return;
+    }
+
+    this.log.debug(`Syncing PXE with the node`);
+    const isSyncing = this.doSync();
+    this.isSyncing = isSyncing;
+    try {
+      await isSyncing;
+    } finally {
+      this.isSyncing = undefined;
+    }
+  }
+
+  private async doSync() {
     let currentHeader;
 
     try {
@@ -86,7 +105,7 @@ export class Synchronizer implements L2BlockStreamEventHandler {
     }
     if (!currentHeader) {
       // REFACTOR: We should know the header of the genesis block without having to request it from the node.
-      await this.db.setHeader(await this.node.getBlockHeader(0));
+      await this.db.setHeader((await this.node.getBlockHeader(0))!);
     }
     await this.blockStream.sync();
   }

package/src/utils/create_pxe_service.ts

@@ -1,14 +1,15 @@
 import { BBNativePrivateKernelProver } from '@aztec/bb-prover';
 import { BBWASMBundlePrivateKernelProver } from '@aztec/bb-prover/wasm/bundle';
-import { type AztecNode, type PrivateKernelProver } from '@aztec/circuit-types';
 import { randomBytes } from '@aztec/foundation/crypto';
 import { createLogger } from '@aztec/foundation/log';
 import { KeyStore } from '@aztec/key-store';
-import { createStore } from '@aztec/kv-store/lmdb';
+import { createStore } from '@aztec/kv-store/lmdb-v2';
 import { L2TipsStore } from '@aztec/kv-store/stores';
+import { BundledProtocolContractsProvider } from '@aztec/protocol-contracts/providers/bundle';
 import { type SimulationProvider, WASMSimulator } from '@aztec/simulator/client';
+import type { AztecNode, PrivateKernelProver } from '@aztec/stdlib/interfaces/client';
 
-import { type PXEServiceConfig } from '../config/index.js';
+import type { PXEServiceConfig } from '../config/index.js';
 import { KVPxeDatabase } from '../database/kv_pxe_database.js';
 import { PXEService } from '../pxe_service/pxe_service.js';
 
@@ -48,7 +49,18 @@ export async function createPXEService(
   const tips = new L2TipsStore(store, 'pxe');
   const simulationProvider = new WASMSimulator();
   const prover = proofCreator ?? (await createProver(config, simulationProvider, logSuffix));
-  const pxe = new PXEService(keyStore, aztecNode, db, tips, prover, simulationProvider, config, logSuffix);
+  const protocolContractsProvider = new BundledProtocolContractsProvider();
+  const pxe = new PXEService(
+    keyStore,
+    aztecNode,
+    db,
+    tips,
+    prover,
+    simulationProvider,
+    protocolContractsProvider,
+    config,
+    logSuffix,
+  );
   await pxe.init();
   return pxe;
 }