@aztec/pxe 0.8.8 → 0.8.10

package/src/contract_tree/index.ts

@@ -22,14 +22,14 @@ import {
   computeVarArgsHash,
   hashConstructor,
 } from '@aztec/circuits.js/abis';
-import { ContractAbi, FunctionSelector } from '@aztec/foundation/abi';
+import { ContractArtifact, FunctionSelector } from '@aztec/foundation/abi';
 import { assertLength } from '@aztec/foundation/serialize';
 import { AztecNode, ContractDao, MerkleTreeId, PublicKey, StateInfoProvider } from '@aztec/types';
 
 /**
  * The ContractTree class represents a Merkle tree of functions for a particular contract.
  * It manages the construction of the function tree, computes its root, and generates membership witnesses
- * for constrained functions. This class also enables lookup of specific function ABI and bytecode using selectors.
+ * for constrained functions. This class also enables lookup of specific function artifact using selectors.
  * It is used in combination with the AztecNode to compute various data for executing private transactions.
  */
 export class ContractTree {
@@ -40,7 +40,7 @@ export class ContractTree {
 
   constructor(
     /**
-     * The contract data object containing the ABI and contract address.
+     * The contract data object containing the artifact and contract address.
      */
     public readonly contract: ContractDao,
     private stateInfoProvider: StateInfoProvider,
@@ -52,13 +52,13 @@ export class ContractTree {
   ) {}
 
   /**
-   * Create a new ContractTree instance from the provided contract ABI, constructor arguments, and related data.
+   * Create a new ContractTree instance from the provided contract artifact, constructor arguments, and related data.
    * The function generates function leaves for constrained functions, computes the function tree root,
    * and hashes the constructor's verification key. It then computes the contract address using the contract
    * and portal contract addresses, contract address salt, and generated data. Finally, it returns a new
    * ContractTree instance containing the contract data and computed values.
    *
-   * @param abi - The contract's ABI containing the functions and their metadata.
+   * @param artifact - The contract's build artifact containing the functions and their metadata.
    * @param args - An array of Fr elements representing the constructor's arguments.
    * @param portalContract - The Ethereum address of the portal smart contract.
    * @param contractAddressSalt - An Fr element representing the salt used to compute the contract address.
@@ -67,7 +67,7 @@ export class ContractTree {
    * @returns A new ContractTree instance containing the contract data and computed values.
    */
   public static async new(
-    abi: ContractAbi,
+    artifact: ContractArtifact,
     args: Fr[],
     portalContract: EthAddress,
     contractAddressSalt: Fr,
@@ -75,29 +75,29 @@ export class ContractTree {
     node: AztecNode,
   ) {
     const wasm = await CircuitsWasm.get();
-    const constructorAbi = abi.functions.find(isConstructor);
-    if (!constructorAbi) {
+    const constructorArtifact = artifact.functions.find(isConstructor);
+    if (!constructorArtifact) {
       throw new Error('Constructor not found.');
     }
-    if (!constructorAbi.verificationKey) {
+    if (!constructorArtifact.verificationKey) {
       throw new Error('Missing verification key for the constructor.');
     }
 
-    const functions = abi.functions.map(f => ({
+    const functions = artifact.functions.map(f => ({
       ...f,
       selector: FunctionSelector.fromNameAndParameters(f.name, f.parameters),
     }));
     const leaves = generateFunctionLeaves(functions, wasm);
     const root = computeFunctionTreeRoot(wasm, leaves);
-    const functionData = FunctionData.fromAbi(constructorAbi);
-    const vkHash = hashVKStr(constructorAbi.verificationKey, wasm);
+    const functionData = FunctionData.fromAbi(constructorArtifact);
+    const vkHash = hashVKStr(constructorArtifact.verificationKey, wasm);
     const argsHash = await computeVarArgsHash(wasm, args);
     const constructorHash = hashConstructor(wasm, functionData, argsHash, vkHash);
 
     const completeAddress = computeCompleteAddress(wasm, from, contractAddressSalt, root, constructorHash);
 
     const contractDao: ContractDao = {
-      ...abi,
+      ...artifact,
       completeAddress,
       functions,
       portalContract,
@@ -110,23 +110,23 @@ export class ContractTree {
   }
 
   /**
-   * Retrieve the ABI of a given function.
+   * Retrieve the artifact of a given function.
    * The function is identified by its selector, which represents a unique identifier for the function's signature.
    * Throws an error if the function with the provided selector is not found in the contract.
    *
    * @param selector - The function selector.
-   * @returns The ABI object containing relevant information about the targeted function.
+   * @returns The artifact object containing relevant information about the targeted function.
    */
-  public getFunctionAbi(selector: FunctionSelector) {
-    const abi = this.contract.functions.find(f => f.selector.equals(selector));
-    if (!abi) {
+  public getFunctionArtifact(selector: FunctionSelector) {
+    const artifact = this.contract.functions.find(f => f.selector.equals(selector));
+    if (!artifact) {
       throw new Error(
-        `Unknown function. Selector ${selector.toString()} not found in the ABI of contract ${this.contract.completeAddress.address.toString()}. Expected one of: ${this.contract.functions
+        `Unknown function. Selector ${selector.toString()} not found in the artifact of contract ${this.contract.completeAddress.address.toString()}. Expected one of: ${this.contract.functions
           .map(f => f.selector.toString())
           .join(', ')}`,
       );
     }
-    return abi;
+    return artifact;
   }
 
   /**
@@ -138,7 +138,7 @@ export class ContractTree {
    * @returns The bytecode of the function as a string.
    */
   public getBytecode(selector: FunctionSelector) {
-    return this.getFunctionAbi(selector).bytecode;
+    return this.getFunctionArtifact(selector).bytecode;
   }
 
   /**

package/src/database/database.ts

@@ -128,4 +128,10 @@ export interface Database extends ContractDatabase {
    * @returns A promise that resolves to an array of AztecAddress instances.
    */
   getCompleteAddresses(): Promise<CompleteAddress[]>;
+
+  /**
+   * Returns the estimated size in bytes of this db.
+   * @returns The estimated size in bytes of this db.
+   */
+  estimateSize(): number;
 }

package/src/database/memory_db.ts

@@ -6,7 +6,7 @@ import { MerkleTreeId, PublicKey } from '@aztec/types';
 
 import { MemoryContractDatabase } from '../contract_database/index.js';
 import { Database } from './database.js';
-import { NoteSpendingInfoDao } from './note_spending_info_dao.js';
+import { NoteSpendingInfoDao, getNoteSpendingInfoDaoSize } from './note_spending_info_dao.js';
 
 /**
  * The MemoryDB class provides an in-memory implementation of a database to manage transactions and auxiliary data.
@@ -144,4 +144,12 @@ export class MemoryDB extends MemoryContractDatabase implements Database {
   public getCompleteAddresses(): Promise<CompleteAddress[]> {
     return Promise.resolve(this.addresses);
   }
+
+  public estimateSize() {
+    const notesSize = this.noteSpendingInfoTable.reduce((sum, note) => sum + getNoteSpendingInfoDaoSize(note), 0);
+    const treeRootsSize = this.treeRoots ? Object.entries(this.treeRoots).length * Fr.SIZE_IN_BYTES : 0;
+    const authWits = Object.entries(this.authWitnesses);
+    const authWitsSize = authWits.reduce((sum, [key, value]) => sum + key.length + value.length * Fr.SIZE_IN_BYTES, 0);
+    return notesSize + treeRootsSize + authWitsSize + this.addresses.length * CompleteAddress.SIZE_IN_BYTES;
+  }
 }

package/src/database/note_spending_info_dao.ts

@@ -62,3 +62,14 @@ export const createRandomNoteSpendingInfoDao = ({
   index,
   publicKey,
 });
+
+/**
+ * Returns the size in bytes of a note spending info dao.
+ * @param note - The note.
+ * @returns - Its size in bytes.
+ */
+export function getNoteSpendingInfoDaoSize(note: NoteSpendingInfoDao) {
+  // 7 fields + 1 bigint + 1 buffer size (4 bytes) + 1 buffer
+  const indexSize = Math.ceil(Math.log2(Number(note.index)));
+  return 7 * Fr.SIZE_IN_BYTES + indexSize + 4 + note.notePreimage.items.length * Fr.SIZE_IN_BYTES;
+}

package/src/kernel_prover/proof_creator.ts

@@ -17,6 +17,7 @@ import { siloCommitment } from '@aztec/circuits.js/abis';
 import { Fr } from '@aztec/foundation/fields';
 import { createDebugLogger } from '@aztec/foundation/log';
 import { elapsed } from '@aztec/foundation/timer';
+import { CircuitSimulationStats } from '@aztec/types/stats';
 
 /**
  * Represents the output of the proof creation process for init and inner private kernel circuit.
@@ -109,17 +110,17 @@ export class KernelProofCreator implements ProofCreator {
 
   public async createProofInit(privateInputs: PrivateKernelInputsInit): Promise<ProofOutput> {
     const wasm = await CircuitsWasm.get();
-    const [time, result] = await elapsed(() => privateKernelSimInit(wasm, privateInputs));
+    const [duration, result] = await elapsed(() => privateKernelSimInit(wasm, privateInputs));
     if (result instanceof CircuitError) {
       throw new CircuitError(result.code, result.message);
     }
     this.log(`Simulated private kernel init`, {
       eventName: 'circuit-simulation',
       circuitName: 'private-kernel-init',
-      duration: time.ms(),
+      duration,
       inputSize: privateInputs.toBuffer().length,
       outputSize: result.toBuffer().length,
-    });
+    } satisfies CircuitSimulationStats);
     this.log('Skipping private kernel init proving...');
     const proof = makeEmptyProof();
 
@@ -131,17 +132,17 @@ export class KernelProofCreator implements ProofCreator {
 
   public async createProofInner(privateInputs: PrivateKernelInputsInner): Promise<ProofOutput> {
     const wasm = await CircuitsWasm.get();
-    const [time, result] = await elapsed(() => privateKernelSimInner(wasm, privateInputs));
+    const [duration, result] = await elapsed(() => privateKernelSimInner(wasm, privateInputs));
     if (result instanceof CircuitError) {
       throw new CircuitError(result.code, result.message);
     }
     this.log(`Simulated private kernel inner`, {
       eventName: 'circuit-simulation',
       circuitName: 'private-kernel-inner',
-      duration: time.ms(),
+      duration,
       inputSize: privateInputs.toBuffer().length,
       outputSize: result.toBuffer().length,
-    });
+    } satisfies CircuitSimulationStats);
     this.log('Skipping private kernel inner proving...');
     const proof = makeEmptyProof();
 
@@ -154,17 +155,17 @@ export class KernelProofCreator implements ProofCreator {
   public async createProofOrdering(privateInputs: PrivateKernelInputsOrdering): Promise<ProofOutputFinal> {
     const wasm = await CircuitsWasm.get();
     this.log('Executing private kernel simulation ordering...');
-    const [time, result] = await elapsed(() => privateKernelSimOrdering(wasm, privateInputs));
+    const [duration, result] = await elapsed(() => privateKernelSimOrdering(wasm, privateInputs));
     if (result instanceof CircuitError) {
       throw new CircuitError(result.code, result.message);
     }
     this.log(`Simulated private kernel ordering`, {
       eventName: 'circuit-simulation',
       circuitName: 'private-kernel-ordering',
-      duration: time.ms(),
+      duration,
       inputSize: privateInputs.toBuffer().length,
       outputSize: result.toBuffer().length,
-    });
+    } satisfies CircuitSimulationStats);
     this.log('Skipping private kernel ordering proving...');
     const proof = makeEmptyProof();
 

package/src/note_processor/note_processor.ts

@@ -5,6 +5,7 @@ import { Fr } from '@aztec/foundation/fields';
 import { createDebugLogger } from '@aztec/foundation/log';
 import { Timer } from '@aztec/foundation/timer';
 import { AztecNode, KeyStore, L2BlockContext, L2BlockL2Logs, NoteSpendingInfo, PublicKey } from '@aztec/types';
+import { NoteProcessorStats } from '@aztec/types/stats';
 
 import { Database, NoteSpendingInfoDao } from '../database/index.js';
 import { getAcirSimulator } from '../simulator/index.js';
@@ -23,16 +24,6 @@ interface ProcessedData {
   noteSpendingInfoDaos: NoteSpendingInfoDao[];
 }
 
-/** Accumulated stats for a note processor.  */
-type NoteProcessorStats = {
-  /** How many notes have been seen and trial-decrypted. */
-  seen: number;
-  /** How many notes were successfully decrypted. */
-  decrypted: number;
-  /** How many notes failed processing. */
-  failed: number;
-};
-
 /**
  * NoteProcessor is responsible for decrypting logs and converting them to notes via their originating contracts
  * before storing them against their owner.
@@ -45,7 +36,7 @@ export class NoteProcessor {
   public readonly timer: Timer = new Timer();
 
   /** Stats accumulated for this processor. */
-  public readonly stats: NoteProcessorStats = { seen: 0, decrypted: 0, failed: 0 };
+  public readonly stats: NoteProcessorStats = { seen: 0, decrypted: 0, failed: 0, blocks: 0, txs: 0 };
 
   constructor(
     /**
@@ -106,6 +97,7 @@ export class NoteProcessor {
 
     // Iterate over both blocks and encrypted logs.
     for (let blockIndex = 0; blockIndex < encryptedL2BlockLogs.length; ++blockIndex) {
+      this.stats.blocks++;
       const { txLogs } = encryptedL2BlockLogs[blockIndex];
       const block = l2BlockContexts[blockIndex].block;
       const dataStartIndexForBlock = block.startPrivateDataTreeSnapshot.nextAvailableLeafIndex;
@@ -117,6 +109,7 @@ export class NoteProcessor {
 
       // Iterate over all the encrypted logs and try decrypting them. If successful, store the note spending info.
       for (let indexOfTxInABlock = 0; indexOfTxInABlock < txLogs.length; ++indexOfTxInABlock) {
+        this.stats.txs++;
         const dataStartIndexForTx = dataStartIndexForBlock + indexOfTxInABlock * MAX_NEW_COMMITMENTS_PER_TX;
         const newCommitments = block.newCommitments.slice(
           indexOfTxInABlock * MAX_NEW_COMMITMENTS_PER_TX,

package/src/pxe_service/pxe_service.ts

@@ -110,6 +110,11 @@ export class PXEService implements PXE {
     this.log.info('Stopped');
   }
 
+  /** Returns an estimate of the db size in bytes. */
+  public estimateDbSize() {
+    return this.db.estimateSize();
+  }
+
   public addAuthWitness(witness: AuthWitness) {
     return this.db.addAuthWitness(witness.requestHash, witness.witness);
   }
@@ -168,7 +173,7 @@ export class PXEService implements PXE {
   }
 
   public async addContracts(contracts: DeployedContract[]) {
-    const contractDaos = contracts.map(c => toContractDao(c.abi, c.completeAddress, c.portalContract));
+    const contractDaos = contracts.map(c => toContractDao(c.artifact, c.completeAddress, c.portalContract));
     await Promise.all(contractDaos.map(c => this.db.addContract(c)));
     for (const contract of contractDaos) {
       const portalInfo =
@@ -334,7 +339,7 @@ export class PXEService implements PXE {
     const functionCall = await this.#getFunctionCall(functionName, args, to);
     const executionResult = await this.#simulateUnconstrained(functionCall);
 
-    // TODO - Return typed result based on the function abi.
+    // TODO - Return typed result based on the function artifact.
     return executionResult;
   }
 
@@ -420,14 +425,14 @@ export class PXEService implements PXE {
 
   /**
    * Retrieves the simulation parameters required to run an ACIR simulation.
-   * This includes the contract address, function ABI, portal contract address, and historic tree roots.
+   * This includes the contract address, function artifact, portal contract address, and historic tree roots.
    *
    * @param execRequest - The transaction request object containing details of the contract call.
-   * @returns An object containing the contract address, function ABI, portal contract address, and historic tree roots.
+   * @returns An object containing the contract address, function artifact, portal contract address, and historic tree roots.
    */
   async #getSimulationParameters(execRequest: FunctionCall | TxExecutionRequest) {
     const contractAddress = (execRequest as FunctionCall).to ?? (execRequest as TxExecutionRequest).origin;
-    const functionAbi = await this.contractDataOracle.getFunctionAbi(
+    const functionArtifact = await this.contractDataOracle.getFunctionArtifact(
       contractAddress,
       execRequest.functionData.selector,
     );
@@ -439,8 +444,8 @@ export class PXEService implements PXE {
 
     return {
       contractAddress,
-      functionAbi: {
-        ...functionAbi,
+      functionArtifact: {
+        ...functionArtifact,
         debug,
       },
       portalContract,
@@ -450,11 +455,11 @@ export class PXEService implements PXE {
   async #simulate(txRequest: TxExecutionRequest): Promise<ExecutionResult> {
     // TODO - Pause syncing while simulating.
 
-    const { contractAddress, functionAbi, portalContract } = await this.#getSimulationParameters(txRequest);
+    const { contractAddress, functionArtifact, portalContract } = await this.#getSimulationParameters(txRequest);
 
     this.log('Executing simulator...');
     try {
-      const result = await this.simulator.run(txRequest, functionAbi, contractAddress, portalContract);
+      const result = await this.simulator.run(txRequest, functionArtifact, contractAddress, portalContract);
       this.log('Simulation completed!');
       return result;
     } catch (err) {
@@ -474,11 +479,11 @@ export class PXEService implements PXE {
    * @returns The simulation result containing the outputs of the unconstrained function.
    */
   async #simulateUnconstrained(execRequest: FunctionCall) {
-    const { contractAddress, functionAbi } = await this.#getSimulationParameters(execRequest);
+    const { contractAddress, functionArtifact } = await this.#getSimulationParameters(execRequest);
 
     this.log('Executing unconstrained simulator...');
     try {
-      const result = await this.simulator.runUnconstrained(execRequest, functionAbi, contractAddress, this.node);
+      const result = await this.simulator.runUnconstrained(execRequest, functionArtifact, contractAddress, this.node);
       this.log('Unconstrained simulation completed!');
 
       return result;
@@ -590,9 +595,9 @@ export class PXEService implements PXE {
         if (contract) {
           err.enrichWithContractName(parsedContractAddress, contract.name);
           selectors.forEach(selector => {
-            const functionAbi = contract.functions.find(f => f.selector.toString() === selector);
-            if (functionAbi) {
-              err.enrichWithFunctionName(parsedContractAddress, functionAbi.selector, functionAbi.name);
+            const functionArtifact = contract.functions.find(f => f.selector.toString() === selector);
+            if (functionArtifact) {
+              err.enrichWithFunctionName(parsedContractAddress, functionArtifact.selector, functionArtifact.name);
             }
           });
         }

package/src/simulator_oracle/index.ts

@@ -1,4 +1,4 @@
-import { DBOracle, FunctionAbiWithDebugMetadata, MessageLoadOracleInputs } from '@aztec/acir-simulator';
+import { DBOracle, FunctionArtifactWithDebugMetadata, MessageLoadOracleInputs } from '@aztec/acir-simulator';
 import {
   AztecAddress,
   CompleteAddress,
@@ -60,14 +60,14 @@ export class SimulatorOracle implements DBOracle {
     );
   }
 
-  async getFunctionABI(
+  async getFunctionArtifact(
     contractAddress: AztecAddress,
     selector: FunctionSelector,
-  ): Promise<FunctionAbiWithDebugMetadata> {
-    const abi = await this.contractDataOracle.getFunctionAbi(contractAddress, selector);
+  ): Promise<FunctionArtifactWithDebugMetadata> {
+    const artifact = await this.contractDataOracle.getFunctionArtifact(contractAddress, selector);
     const debug = await this.contractDataOracle.getFunctionDebugMetadata(contractAddress, selector);
     return {
-      ...abi,
+      ...artifact,
       debug,
     };
   }

package/src/synchronizer/synchronizer.ts

@@ -3,6 +3,7 @@ import { computeGlobalsHash } from '@aztec/circuits.js/abis';
 import { DebugLogger, createDebugLogger } from '@aztec/foundation/log';
 import { InterruptableSleep } from '@aztec/foundation/sleep';
 import { AztecNode, INITIAL_L2_BLOCK_NUM, KeyStore, L2BlockContext, L2BlockL2Logs, LogType } from '@aztec/types';
+import { NoteProcessorCaughtUpStats } from '@aztec/types/stats';
 
 import { Database } from '../database/index.js';
 import { NoteProcessor } from '../note_processor/index.js';
@@ -182,8 +183,9 @@ export class Synchronizer {
           eventName: 'note-processor-caught-up',
           publicKey: noteProcessor.publicKey.toString(),
           duration: noteProcessor.timer.ms(),
+          dbSize: this.db.estimateSize(),
           ...noteProcessor.stats,
-        });
+        } satisfies NoteProcessorCaughtUpStats);
         this.noteProcessorsToCatchUp.shift();
         this.noteProcessors.push(noteProcessor);
       }