@aztec/pxe 0.0.0-test.1 → 0.0.1-commit.0208eb9

package/src/storage/address_data_provider/index.ts

@@ -1 +0,0 @@
-export { AddressDataProvider } from './address_data_provider.js';

package/src/storage/auth_witness_data_provider/auth_witness_data_provider.ts

@@ -1,34 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-import { toArray } from '@aztec/foundation/iterable';
-import type { AztecAsyncKVStore, AztecAsyncMap } from '@aztec/kv-store';
-
-import type { DataProvider } from '../data_provider.js';
-
-export class AuthWitnessDataProvider implements DataProvider {
-  #store: AztecAsyncKVStore;
-  #authWitnesses: AztecAsyncMap<string, Buffer[]>;
-
-  constructor(store: AztecAsyncKVStore) {
-    this.#store = store;
-    this.#authWitnesses = this.#store.openMap('auth_witnesses');
-  }
-
-  async addAuthWitness(messageHash: Fr, witness: Fr[]): Promise<void> {
-    await this.#authWitnesses.set(
-      messageHash.toString(),
-      witness.map(w => w.toBuffer()),
-    );
-  }
-
-  async getAuthWitness(messageHash: Fr): Promise<Fr[] | undefined> {
-    const witness = await this.#authWitnesses.getAsync(messageHash.toString());
-    return witness?.map(w => Fr.fromBuffer(w));
-  }
-
-  async getSize(): Promise<number> {
-    return (await toArray(this.#authWitnesses.valuesAsync())).reduce(
-      (sum, value) => sum + value.length * Fr.SIZE_IN_BYTES,
-      0,
-    );
-  }
-}

package/src/storage/auth_witness_data_provider/index.ts

@@ -1 +0,0 @@
-export { AuthWitnessDataProvider } from './auth_witness_data_provider.js';

package/src/storage/capsule_data_provider/capsule_data_provider.ts

@@ -1,80 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-import { toArray } from '@aztec/foundation/iterable';
-import { type LogFn, createDebugOnlyLogger } from '@aztec/foundation/log';
-import type { AztecAsyncKVStore, AztecAsyncMap } from '@aztec/kv-store';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-
-import type { DataProvider } from '../data_provider.js';
-
-export class CapsuleDataProvider implements DataProvider {
-  #store: AztecAsyncKVStore;
-
-  // Arbitrary data stored by contracts. Key is computed as `${contractAddress}:${key}`
-  #capsules: AztecAsyncMap<string, Buffer>;
-
-  debug: LogFn;
-
-  constructor(store: AztecAsyncKVStore) {
-    this.#store = store;
-
-    this.#capsules = this.#store.openMap('capsules');
-
-    this.debug = createDebugOnlyLogger('pxe:capsule-data-provider');
-  }
-
-  async storeCapsule(contractAddress: AztecAddress, slot: Fr, capsule: Fr[]): Promise<void> {
-    await this.#capsules.set(dbSlotToKey(contractAddress, slot), Buffer.concat(capsule.map(value => value.toBuffer())));
-  }
-
-  async loadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null> {
-    const dataBuffer = await this.#capsules.getAsync(dbSlotToKey(contractAddress, slot));
-    if (!dataBuffer) {
-      this.debug(`Data not found for contract ${contractAddress.toString()} and slot ${slot.toString()}`);
-      return null;
-    }
-    const capsule: Fr[] = [];
-    for (let i = 0; i < dataBuffer.length; i += Fr.SIZE_IN_BYTES) {
-      capsule.push(Fr.fromBuffer(dataBuffer.subarray(i, i + Fr.SIZE_IN_BYTES)));
-    }
-    return capsule;
-  }
-
-  async deleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void> {
-    await this.#capsules.delete(dbSlotToKey(contractAddress, slot));
-  }
-
-  async copyCapsule(contractAddress: AztecAddress, srcSlot: Fr, dstSlot: Fr, numEntries: number): Promise<void> {
-    // In order to support overlapping source and destination regions, we need to check the relative positions of source
-    // and destination. If destination is ahead of source, then by the time we overwrite source elements using forward
-    // indexes we'll have already read those. On the contrary, if source is ahead of destination we need to use backward
-    // indexes to avoid reading elements that've been overwritten.
-
-    const indexes = Array.from(Array(numEntries).keys());
-    if (srcSlot.lt(dstSlot)) {
-      indexes.reverse();
-    }
-
-    for (const i of indexes) {
-      const currentSrcSlot = dbSlotToKey(contractAddress, srcSlot.add(new Fr(i)));
-      const currentDstSlot = dbSlotToKey(contractAddress, dstSlot.add(new Fr(i)));
-
-      const toCopy = await this.#capsules.getAsync(currentSrcSlot);
-      if (!toCopy) {
-        throw new Error(`Attempted to copy empty slot ${currentSrcSlot} for contract ${contractAddress.toString()}`);
-      }
-
-      await this.#capsules.set(currentDstSlot, toCopy);
-    }
-  }
-
-  public async getSize() {
-    return (await toArray(this.#capsules.valuesAsync())).reduce(
-      (sum, value) => sum + value.length * Fr.SIZE_IN_BYTES,
-      0,
-    );
-  }
-}
-
-function dbSlotToKey(contractAddress: AztecAddress, slot: Fr): string {
-  return `${contractAddress.toString()}:${slot.toString()}`;
-}

package/src/storage/capsule_data_provider/index.ts

@@ -1 +0,0 @@
-export { CapsuleDataProvider } from './capsule_data_provider.js';

package/src/storage/contract_data_provider/contract_data_provider.ts

@@ -1,261 +0,0 @@
-import type { Fr } from '@aztec/foundation/fields';
-import { toArray } from '@aztec/foundation/iterable';
-import type { MembershipWitness } from '@aztec/foundation/trees';
-import type { AztecAsyncKVStore, AztecAsyncMap } from '@aztec/kv-store';
-import { ContractClassNotFoundError, ContractNotFoundError } from '@aztec/simulator/client';
-import {
-  type ContractArtifact,
-  type FunctionArtifact,
-  type FunctionDebugMetadata,
-  FunctionSelector,
-  FunctionType,
-  contractArtifactFromBuffer,
-  contractArtifactToBuffer,
-  getFunctionDebugMetadata,
-} from '@aztec/stdlib/abi';
-import { AztecAddress } from '@aztec/stdlib/aztec-address';
-import {
-  type ContractClass,
-  type ContractInstanceWithAddress,
-  SerializableContractInstance,
-} from '@aztec/stdlib/contract';
-
-import type { DataProvider } from '../data_provider.js';
-import { PrivateFunctionsTree } from './private_functions_tree.js';
-
-/**
- * ContractDataProvider serves as a data manager and retriever for Aztec.nr contracts.
- * It provides methods to obtain contract addresses, function ABI, bytecode, and membership witnesses
- * from a given contract address and function selector. The class maintains a cache of ContractTree instances
- * to efficiently serve the requested data. It interacts with the ContractDatabase and AztecNode to fetch
- * the required information and facilitate cryptographic proof generation.
- */
-export class ContractDataProvider implements DataProvider {
-  /** Map from contract class id to private function tree. */
-  private contractClassesCache: Map<string, PrivateFunctionsTree> = new Map();
-
-  #contractArtifacts: AztecAsyncMap<string, Buffer>;
-  #contractInstances: AztecAsyncMap<string, Buffer>;
-
-  constructor(store: AztecAsyncKVStore) {
-    this.#contractArtifacts = store.openMap('contract_artifacts');
-    this.#contractInstances = store.openMap('contracts_instances');
-  }
-
-  // Setters
-
-  public async addContractArtifact(id: Fr, contract: ContractArtifact): Promise<void> {
-    const privateFunctions = contract.functions.filter(
-      functionArtifact => functionArtifact.functionType === FunctionType.PRIVATE,
-    );
-
-    const privateSelectors = await Promise.all(
-      privateFunctions.map(async privateFunctionArtifact =>
-        (
-          await FunctionSelector.fromNameAndParameters(privateFunctionArtifact.name, privateFunctionArtifact.parameters)
-        ).toString(),
-      ),
-    );
-
-    if (privateSelectors.length !== new Set(privateSelectors).size) {
-      throw new Error('Repeated function selectors of private functions');
-    }
-
-    await this.#contractArtifacts.set(id.toString(), contractArtifactToBuffer(contract));
-  }
-
-  async addContractInstance(contract: ContractInstanceWithAddress): Promise<void> {
-    await this.#contractInstances.set(
-      contract.address.toString(),
-      new SerializableContractInstance(contract).toBuffer(),
-    );
-  }
-
-  // Private getters
-
-  async #getContractInstance(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined> {
-    const contract = await this.#contractInstances.getAsync(address.toString());
-    return contract && SerializableContractInstance.fromBuffer(contract).withAddress(address);
-  }
-
-  async #getContractArtifact(id: Fr): Promise<ContractArtifact | undefined> {
-    const contract = await this.#contractArtifacts.getAsync(id.toString());
-    // TODO(@spalladino): AztecAsyncMap lies and returns Uint8Arrays instead of Buffers, hence the extra Buffer.from.
-    return contract && contractArtifactFromBuffer(Buffer.from(contract));
-  }
-
-  /**
-   * Retrieve or create a ContractTree instance based on the provided class id.
-   * If an existing tree with the same class id is found in the cache, it will be returned.
-   * Otherwise, a new ContractTree instance will be created using the contract data from the database
-   * and added to the cache before returning.
-   *
-   * @param classId - The class id of the contract for which the ContractTree is required.
-   * @returns A ContractTree instance associated with the specified contract address.
-   * @throws An Error if the contract is not found in the ContractDatabase.
-   */
-  private async getTreeForClassId(classId: Fr): Promise<PrivateFunctionsTree> {
-    if (!this.contractClassesCache.has(classId.toString())) {
-      const artifact = await this.#getContractArtifact(classId);
-      if (!artifact) {
-        throw new ContractClassNotFoundError(classId.toString());
-      }
-      const tree = await PrivateFunctionsTree.create(artifact);
-      this.contractClassesCache.set(classId.toString(), tree);
-    }
-    return this.contractClassesCache.get(classId.toString())!;
-  }
-
-  /**
-   * Retrieve or create a ContractTree instance based on the provided AztecAddress.
-   * If an existing tree with the same contract address is found in the cache, it will be returned.
-   * Otherwise, a new ContractTree instance will be created using the contract data from the database
-   * and added to the cache before returning.
-   *
-   * @param contractAddress - The AztecAddress of the contract for which the ContractTree is required.
-   * @returns A ContractTree instance associated with the specified contract address.
-   * @throws An Error if the contract is not found in the ContractDatabase.
-   */
-  private async getTreeForAddress(contractAddress: AztecAddress): Promise<PrivateFunctionsTree> {
-    const instance = await this.getContractInstance(contractAddress);
-    return this.getTreeForClassId(instance.currentContractClassId);
-  }
-
-  // Public getters
-
-  async getContractsAddresses(): Promise<AztecAddress[]> {
-    const keys = await toArray(this.#contractInstances.keysAsync());
-    return keys.map(AztecAddress.fromString);
-  }
-
-  /** Returns a contract instance for a given address. Throws if not found. */
-  public async getContractInstance(contractAddress: AztecAddress): Promise<ContractInstanceWithAddress> {
-    const instance = await this.#getContractInstance(contractAddress);
-    if (!instance) {
-      throw new ContractNotFoundError(contractAddress.toString());
-    }
-    return instance;
-  }
-
-  public async getContractArtifact(contractClassId: Fr): Promise<ContractArtifact> {
-    const tree = await this.getTreeForClassId(contractClassId);
-    return tree.getArtifact();
-  }
-
-  /** Returns a contract class for a given class id. Throws if not found. */
-  public async getContractClass(contractClassId: Fr): Promise<ContractClass> {
-    const tree = await this.getTreeForClassId(contractClassId);
-    return tree.getContractClass();
-  }
-
-  public async getContract(
-    address: AztecAddress,
-  ): Promise<(ContractInstanceWithAddress & ContractArtifact) | undefined> {
-    const instance = await this.getContractInstance(address);
-    const artifact = instance && (await this.getContractArtifact(instance?.currentContractClassId));
-    if (!instance || !artifact) {
-      return undefined;
-    }
-    return { ...instance, ...artifact };
-  }
-
-  /**
-   * Retrieves the artifact of a specified function within a given contract.
-   * The function is identified by its selector, which is a unique code generated from the function's signature.
-   * Throws an error if the contract address or function selector are invalid or not found.
-   *
-   * @param contractAddress - The AztecAddress representing the contract containing the function.
-   * @param selector - The function selector.
-   * @returns The corresponding function's artifact as an object.
-   */
-  public async getFunctionArtifact(contractAddress: AztecAddress, selector: FunctionSelector) {
-    const tree = await this.getTreeForAddress(contractAddress);
-    return tree.getFunctionArtifact(selector);
-  }
-
-  /**
-   * Retrieves the artifact of a specified function within a given contract.
-   * The function is identified by its name, which is unique within a contract.
-   * Throws if the contract has not been added to the database.
-   *
-   * @param contractAddress - The AztecAddress representing the contract containing the function.
-   * @param functionName - The name of the function.
-   * @returns The corresponding function's artifact as an object
-   */
-  public async getFunctionArtifactByName(
-    contractAddress: AztecAddress,
-    functionName: string,
-  ): Promise<FunctionArtifact | undefined> {
-    const tree = await this.getTreeForAddress(contractAddress);
-    return tree.getArtifact().functions.find(f => f.name === functionName);
-  }
-
-  /**
-   * Retrieves the debug metadata of a specified function within a given contract.
-   * The function is identified by its selector, which is a unique code generated from the function's signature.
-   * Returns undefined if the debug metadata for the given function is not found.
-   * Throws if the contract has not been added to the database.
-   *
-   * @param contractAddress - The AztecAddress representing the contract containing the function.
-   * @param selector - The function selector.
-   * @returns The corresponding function's artifact as an object.
-   */
-  public async getFunctionDebugMetadata(
-    contractAddress: AztecAddress,
-    selector: FunctionSelector,
-  ): Promise<FunctionDebugMetadata | undefined> {
-    const tree = await this.getTreeForAddress(contractAddress);
-    const artifact = await tree.getFunctionArtifact(selector);
-    return getFunctionDebugMetadata(tree.getArtifact(), artifact);
-  }
-
-  /**
-   * Retrieve the bytecode of a specific function in a contract at the given address.
-   * The returned bytecode is required for executing and verifying the function's behavior
-   * in the Aztec network. Throws an error if the contract or function cannot be found.
-   *
-   * @param contractAddress - The contract's address.
-   * @param selector - The function selector.
-   * @returns A Promise that resolves to a Buffer containing the bytecode of the specified function.
-   * @throws Error if the contract address is unknown or not found.
-   */
-  public async getBytecode(contractAddress: AztecAddress, selector: FunctionSelector) {
-    const tree = await this.getTreeForAddress(contractAddress);
-    return tree.getBytecode(selector);
-  }
-
-  /**
-   * Retrieve the function membership witness for the given contract class and function selector.
-   * The function membership witness represents a proof that the function belongs to the specified contract.
-   * Throws an error if the contract address or function selector is unknown.
-   *
-   * @param contractClassId - The id of the class.
-   * @param selector - The function selector.
-   * @returns A promise that resolves with the MembershipWitness instance for the specified contract's function.
-   */
-  public async getFunctionMembershipWitness(
-    contractClassId: Fr,
-    selector: FunctionSelector,
-  ): Promise<MembershipWitness<5>> {
-    const tree = await this.getTreeForClassId(contractClassId);
-    return tree.getFunctionMembershipWitness(selector);
-  }
-
-  public async getDebugContractName(contractAddress: AztecAddress) {
-    const tree = await this.getTreeForAddress(contractAddress);
-    return tree.getArtifact().name;
-  }
-
-  public async getDebugFunctionName(contractAddress: AztecAddress, selector: FunctionSelector) {
-    const tree = await this.getTreeForAddress(contractAddress);
-    const { name: contractName } = tree.getArtifact();
-    const { name: functionName } = await tree.getFunctionArtifact(selector);
-    return `${contractName}:${functionName}`;
-  }
-
-  public async getSize() {
-    return (await toArray(this.#contractInstances.valuesAsync()))
-      .concat(await toArray(this.#contractArtifacts.valuesAsync()))
-      .reduce((sum, value) => sum + value.length, 0);
-  }
-}

package/src/storage/contract_data_provider/index.ts

@@ -1,2 +0,0 @@
-export { ContractDataProvider } from './contract_data_provider.js';
-export { PrivateFunctionsTree } from './private_functions_tree.js';

package/src/storage/contract_data_provider/private_functions_tree.ts

@@ -1,131 +0,0 @@
-import { FUNCTION_TREE_HEIGHT } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/fields';
-import { assertLength } from '@aztec/foundation/serialize';
-import { MembershipWitness, type MerkleTree } from '@aztec/foundation/trees';
-import { type ContractArtifact, FunctionSelector } from '@aztec/stdlib/abi';
-import {
-  type ContractClassWithId,
-  computePrivateFunctionLeaf,
-  computePrivateFunctionsTree,
-  getContractClassFromArtifact,
-} from '@aztec/stdlib/contract';
-
-/**
- * Represents a Merkle tree of functions for a particular Contract Class.
- * 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 artifact using selectors.
- * It is used in combination with the AztecNode to compute various data for executing private transactions.
- */
-export class PrivateFunctionsTree {
-  private tree?: MerkleTree;
-
-  private constructor(private readonly artifact: ContractArtifact, private contractClass: ContractClassWithId) {}
-
-  static async create(artifact: ContractArtifact) {
-    const contractClass = await getContractClassFromArtifact(artifact);
-    return new PrivateFunctionsTree(artifact, contractClass);
-  }
-
-  /**
-   * 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 artifact object containing relevant information about the targeted function.
-   */
-  public async getFunctionArtifact(selector: FunctionSelector) {
-    const functionsAndSelectors = await Promise.all(
-      this.artifact.functions.map(async f => ({
-        f,
-        selector: await FunctionSelector.fromNameAndParameters(f.name, f.parameters),
-      })),
-    );
-    const artifact = functionsAndSelectors.find(f => selector.equals(f.selector))?.f;
-    if (!artifact) {
-      throw new Error(
-        `Unknown function. Selector ${selector.toString()} not found in the artifact ${
-          this.artifact.name
-        } with class ${this.getContractClassId().toString()}.`,
-      );
-    }
-    return artifact;
-  }
-
-  /**
-   * Retrieve the bytecode of a function in the contract by its function selector.
-   * The function selector is a unique identifier for each function in a contract.
-   * Throws an error if the function with the given selector is not found in the contract.
-   *
-   * @param selector - The selector of a function to get bytecode for.
-   * @returns The bytecode of the function as a string.
-   */
-  public async getBytecode(selector: FunctionSelector) {
-    const artifact = await this.getFunctionArtifact(selector);
-    return artifact.bytecode;
-  }
-
-  /**
-   * Calculate and return the root of the function tree for the current contract.
-   * This root is a cryptographic commitment to the set of constrained functions within the contract,
-   * which is used in the Aztec node's proof system. The root will be cached after the first call.
-   *
-   * @returns A promise that resolves to the Fr (finite field element) representation of the function tree root.
-   */
-  public getFunctionTreeRoot() {
-    return this.getTree();
-  }
-
-  /** Returns the contract class object. */
-  public getContractClass() {
-    return this.contractClass;
-  }
-
-  /** Returns the contract artifact. */
-  public getArtifact() {
-    return this.artifact;
-  }
-
-  /**
-   * Returns the contract class identifier for the given artifact.
-   */
-  public getContractClassId() {
-    return this.getContractClass().id;
-  }
-
-  /**
-   * Retrieve the membership witness of a function within a contract's function tree.
-   * A membership witness represents the position and authentication path of a target function
-   * in the Merkle tree of constrained functions. It is required to prove the existence of the
-   * function within the contract during execution. Throws if fn does not exist or is not private.
-   *
-   * @param selector - The function selector.
-   * @returns A MembershipWitness instance representing the position and authentication path of the function in the function tree.
-   */
-  public async getFunctionMembershipWitness(
-    selector: FunctionSelector,
-  ): Promise<MembershipWitness<typeof FUNCTION_TREE_HEIGHT>> {
-    const fn = this.getContractClass().privateFunctions.find(f => f.selector.equals(selector));
-    if (!fn) {
-      throw new Error(`Private function with selector ${selector.toString()} not found in contract class.`);
-    }
-
-    const leaf = await computePrivateFunctionLeaf(fn);
-    const tree = await this.getTree();
-    const index = tree.getIndex(leaf);
-    const path = tree.getSiblingPath(index);
-    return new MembershipWitness<typeof FUNCTION_TREE_HEIGHT>(
-      FUNCTION_TREE_HEIGHT,
-      BigInt(index),
-      assertLength(path.map(Fr.fromBuffer), FUNCTION_TREE_HEIGHT),
-    );
-  }
-
-  private async getTree() {
-    if (!this.tree) {
-      const fns = this.getContractClass().privateFunctions;
-      this.tree = await computePrivateFunctionsTree(fns);
-    }
-    return this.tree;
-  }
-}

package/src/storage/data_provider.ts

@@ -1,3 +0,0 @@
-export interface DataProvider {
-  getSize(): Promise<number>;
-}

package/src/storage/note_data_provider/index.ts

@@ -1,2 +0,0 @@
-export { NoteDao } from './note_dao.js';
-export { NoteDataProvider } from './note_data_provider.js';