@aztec/pxe 0.0.0-test.1 → 0.0.1-commit.03f7ef2

package/dest/storage/contract_data_provider/contract_data_provider.js

@@ -1,8 +1,7 @@
 import { toArray } from '@aztec/foundation/iterable';
-import { ContractClassNotFoundError, ContractNotFoundError } from '@aztec/simulator/client';
-import { FunctionSelector, FunctionType, contractArtifactFromBuffer, contractArtifactToBuffer, getFunctionDebugMetadata } from '@aztec/stdlib/abi';
+import { FunctionSelector, FunctionType, contractArtifactFromBuffer, contractArtifactToBuffer, encodeArguments, getFunctionDebugMetadata } from '@aztec/stdlib/abi';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
-import { SerializableContractInstance } from '@aztec/stdlib/contract';
+import { SerializableContractInstance, getContractClassFromArtifact } from '@aztec/stdlib/contract';
 import { PrivateFunctionsTree } from './private_functions_tree.js';
 /**
  * ContractDataProvider serves as a data manager and retriever for Aztec.nr contracts.
@@ -11,7 +10,9 @@ import { PrivateFunctionsTree } from './private_functions_tree.js';
  * 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 {
-    /** Map from contract class id to private function tree. */ contractClassesCache = new Map();
+    /** Map from contract class id to private function tree. */ // TODO: Update it to be LRU cache so that it doesn't keep all the data all the time.
+    #privateFunctionTrees = new Map();
+    /** Map from contract address to contract class id */ #contractClassIdMap = new Map();
     #contractArtifacts;
     #contractInstances;
     constructor(store){
@@ -28,17 +29,19 @@ import { PrivateFunctionsTree } from './private_functions_tree.js';
         await this.#contractArtifacts.set(id.toString(), contractArtifactToBuffer(contract));
     }
     async addContractInstance(contract) {
+        this.#contractClassIdMap.set(contract.address.toString(), contract.currentContractClassId);
         await this.#contractInstances.set(contract.address.toString(), new SerializableContractInstance(contract).toBuffer());
     }
     // Private getters
-    async #getContractInstance(address) {
-        const contract = await this.#contractInstances.getAsync(address.toString());
-        return contract && SerializableContractInstance.fromBuffer(contract).withAddress(address);
-    }
-    async #getContractArtifact(id) {
-        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));
+    async #getContractClassId(contractAddress) {
+        if (!this.#contractClassIdMap.has(contractAddress.toString())) {
+            const instance = await this.getContractInstance(contractAddress);
+            if (!instance) {
+                return;
+            }
+            this.#contractClassIdMap.set(contractAddress.toString(), instance.currentContractClassId);
+        }
+        return this.#contractClassIdMap.get(contractAddress.toString());
     }
     /**
    * Retrieve or create a ContractTree instance based on the provided class id.
@@ -49,29 +52,20 @@ import { PrivateFunctionsTree } from './private_functions_tree.js';
    * @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.
-   */ async getTreeForClassId(classId) {
-        if (!this.contractClassesCache.has(classId.toString())) {
-            const artifact = await this.#getContractArtifact(classId);
+   */ async #getPrivateFunctionTreeForClassId(classId) {
+        if (!this.#privateFunctionTrees.has(classId.toString())) {
+            const artifact = await this.getContractArtifact(classId);
             if (!artifact) {
-                throw new ContractClassNotFoundError(classId.toString());
+                return;
             }
             const tree = await PrivateFunctionsTree.create(artifact);
-            this.contractClassesCache.set(classId.toString(), tree);
+            this.#privateFunctionTrees.set(classId.toString(), tree);
         }
-        return this.contractClassesCache.get(classId.toString());
+        return this.#privateFunctionTrees.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.
-   */ async getTreeForAddress(contractAddress) {
-        const instance = await this.getContractInstance(contractAddress);
-        return this.getTreeForClassId(instance.currentContractClassId);
+    async #getContractArtifactByAddress(contractAddress) {
+        const contractClassId = await this.#getContractClassId(contractAddress);
+        return contractClassId && this.getContractArtifact(contractClassId);
     }
     // Public getters
     async getContractsAddresses() {
@@ -79,25 +73,26 @@ import { PrivateFunctionsTree } from './private_functions_tree.js';
         return keys.map(AztecAddress.fromString);
     }
     /** Returns a contract instance for a given address. Throws if not found. */ async getContractInstance(contractAddress) {
-        const instance = await this.#getContractInstance(contractAddress);
-        if (!instance) {
-            throw new ContractNotFoundError(contractAddress.toString());
-        }
-        return instance;
+        const contract = await this.#contractInstances.getAsync(contractAddress.toString());
+        return contract && SerializableContractInstance.fromBuffer(contract).withAddress(contractAddress);
     }
     async getContractArtifact(contractClassId) {
-        const tree = await this.getTreeForClassId(contractClassId);
-        return tree.getArtifact();
+        const contract = await this.#contractArtifacts.getAsync(contractClassId.toString());
+        // TODO(@spalladino): AztecAsyncMap lies and returns Uint8Arrays instead of Buffers, hence the extra Buffer.from.
+        return contract && contractArtifactFromBuffer(Buffer.from(contract));
     }
     /** Returns a contract class for a given class id. Throws if not found. */ async getContractClass(contractClassId) {
-        const tree = await this.getTreeForClassId(contractClassId);
-        return tree.getContractClass();
+        const artifact = await this.getContractArtifact(contractClassId);
+        return artifact && getContractClassFromArtifact(artifact);
     }
     async getContract(address) {
         const instance = await this.getContractInstance(address);
-        const artifact = instance && await this.getContractArtifact(instance?.currentContractClassId);
-        if (!instance || !artifact) {
-            return undefined;
+        if (!instance) {
+            return;
+        }
+        const artifact = await this.getContractArtifact(instance.currentContractClassId);
+        if (!artifact) {
+            return;
         }
         return {
             ...instance,
@@ -113,20 +108,35 @@ import { PrivateFunctionsTree } from './private_functions_tree.js';
    * @param selector - The function selector.
    * @returns The corresponding function's artifact as an object.
    */ async getFunctionArtifact(contractAddress, selector) {
-        const tree = await this.getTreeForAddress(contractAddress);
-        return tree.getFunctionArtifact(selector);
+        const artifact = await this.#getContractArtifactByAddress(contractAddress);
+        const fnArtifact = artifact && await this.#findFunctionArtifactBySelector(artifact, selector);
+        return fnArtifact && {
+            ...fnArtifact,
+            contractName: artifact.name
+        };
     }
-    /**
-   * 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
-   */ async getFunctionArtifactByName(contractAddress, functionName) {
-        const tree = await this.getTreeForAddress(contractAddress);
-        return tree.getArtifact().functions.find((f)=>f.name === functionName);
+    async getFunctionArtifactWithDebugMetadata(contractAddress, selector) {
+        const artifact = await this.getFunctionArtifact(contractAddress, selector);
+        if (!artifact) {
+            throw new Error(`Function artifact not found for contract ${contractAddress} and selector ${selector}.`);
+        }
+        const debug = await this.getFunctionDebugMetadata(contractAddress, selector);
+        return {
+            ...artifact,
+            debug
+        };
+    }
+    async getPublicFunctionArtifact(contractAddress) {
+        const artifact = await this.#getContractArtifactByAddress(contractAddress);
+        const fnArtifact = artifact && artifact.functions.find((fn)=>fn.functionType === FunctionType.PUBLIC);
+        return fnArtifact && {
+            ...fnArtifact,
+            contractName: artifact.name
+        };
+    }
+    async getFunctionAbi(contractAddress, selector) {
+        const artifact = await this.#getContractArtifactByAddress(contractAddress);
+        return artifact && await this.#findFunctionAbiBySelector(artifact, selector);
     }
     /**
    * Retrieves the debug metadata of a specified function within a given contract.
@@ -138,22 +148,14 @@ import { PrivateFunctionsTree } from './private_functions_tree.js';
    * @param selector - The function selector.
    * @returns The corresponding function's artifact as an object.
    */ async getFunctionDebugMetadata(contractAddress, selector) {
-        const tree = await this.getTreeForAddress(contractAddress);
-        const artifact = await tree.getFunctionArtifact(selector);
-        return getFunctionDebugMetadata(tree.getArtifact(), artifact);
+        const artifact = await this.#getContractArtifactByAddress(contractAddress);
+        const fnArtifact = artifact && await this.#findFunctionArtifactBySelector(artifact, selector);
+        return fnArtifact && getFunctionDebugMetadata(artifact, fnArtifact);
     }
-    /**
-   * 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.
-   */ async getBytecode(contractAddress, selector) {
-        const tree = await this.getTreeForAddress(contractAddress);
-        return tree.getBytecode(selector);
+    async getPublicFunctionDebugMetadata(contractAddress) {
+        const artifact = await this.#getContractArtifactByAddress(contractAddress);
+        const fnArtifact = artifact && artifact.functions.find((fn)=>fn.functionType === FunctionType.PUBLIC);
+        return fnArtifact && getFunctionDebugMetadata(artifact, fnArtifact);
     }
     /**
    * Retrieve the function membership witness for the given contract class and function selector.
@@ -164,20 +166,59 @@ import { PrivateFunctionsTree } from './private_functions_tree.js';
    * @param selector - The function selector.
    * @returns A promise that resolves with the MembershipWitness instance for the specified contract's function.
    */ async getFunctionMembershipWitness(contractClassId, selector) {
-        const tree = await this.getTreeForClassId(contractClassId);
-        return tree.getFunctionMembershipWitness(selector);
+        const tree = await this.#getPrivateFunctionTreeForClassId(contractClassId);
+        return tree?.getFunctionMembershipWitness(selector);
     }
     async getDebugContractName(contractAddress) {
-        const tree = await this.getTreeForAddress(contractAddress);
-        return tree.getArtifact().name;
+        const artifact = await this.#getContractArtifactByAddress(contractAddress);
+        return artifact?.name;
     }
     async getDebugFunctionName(contractAddress, selector) {
-        const tree = await this.getTreeForAddress(contractAddress);
-        const { name: contractName } = tree.getArtifact();
-        const { name: functionName } = await tree.getFunctionArtifact(selector);
-        return `${contractName}:${functionName}`;
+        const artifact = await this.#getContractArtifactByAddress(contractAddress);
+        const fnArtifact = artifact && await this.#findFunctionAbiBySelector(artifact, selector);
+        return `${artifact?.name ?? contractAddress}:${fnArtifact?.name ?? selector}`;
+    }
+    async #findFunctionArtifactBySelector(artifact, selector) {
+        const functions = artifact.functions;
+        for(let i = 0; i < functions.length; i++){
+            const fn = functions[i];
+            const fnSelector = await FunctionSelector.fromNameAndParameters(fn.name, fn.parameters);
+            if (fnSelector.equals(selector)) {
+                return fn;
+            }
+        }
+    }
+    async #findFunctionAbiBySelector(artifact, selector) {
+        const functions = [
+            ...artifact.functions,
+            ...artifact.nonDispatchPublicFunctions ?? []
+        ];
+        for(let i = 0; i < functions.length; i++){
+            const fn = functions[i];
+            const fnSelector = await FunctionSelector.fromNameAndParameters(fn.name, fn.parameters);
+            if (fnSelector.equals(selector)) {
+                return fn;
+            }
+        }
     }
-    async getSize() {
-        return (await toArray(this.#contractInstances.valuesAsync())).concat(await toArray(this.#contractArtifacts.valuesAsync())).reduce((sum, value)=>sum + value.length, 0);
+    async getFunctionCall(functionName, args, to) {
+        const contract = await this.getContract(to);
+        if (!contract) {
+            throw new Error(`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`);
+        }
+        const functionDao = contract.functions.find((f)=>f.name === functionName);
+        if (!functionDao) {
+            throw new Error(`Unknown function ${functionName} in contract ${contract.name}.`);
+        }
+        return {
+            name: functionDao.name,
+            args: encodeArguments(functionDao, args),
+            selector: await FunctionSelector.fromNameAndParameters(functionDao.name, functionDao.parameters),
+            type: functionDao.functionType,
+            to,
+            hideMsgSender: false,
+            isStatic: functionDao.isStatic,
+            returnTypes: functionDao.returnTypes
+        };
     }
 }

package/dest/storage/contract_data_provider/index.d.ts

@@ -1,3 +1,2 @@
 export { ContractDataProvider } from './contract_data_provider.js';
-export { PrivateFunctionsTree } from './private_functions_tree.js';
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9zdG9yYWdlL2NvbnRyYWN0X2RhdGFfcHJvdmlkZXIvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLG9CQUFvQixFQUFFLE1BQU0sNkJBQTZCLENBQUMifQ==

package/dest/storage/contract_data_provider/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/storage/contract_data_provider/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/storage/contract_data_provider/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC"}

package/dest/storage/contract_data_provider/index.js

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

package/dest/storage/contract_data_provider/private_functions_tree.d.ts

@@ -1,10 +1,6 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
 import { FUNCTION_TREE_HEIGHT } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/fields';
-import { MembershipWitness, type MerkleTree } from '@aztec/foundation/trees';
+import { MembershipWitness } from '@aztec/foundation/trees';
 import { type ContractArtifact, FunctionSelector } from '@aztec/stdlib/abi';
-import { type ContractClassWithId } 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
@@ -12,45 +8,10 @@ import { type ContractClassWithId } from '@aztec/stdlib/contract';
  * It is used in combination with the AztecNode to compute various data for executing private transactions.
  */
 export declare class PrivateFunctionsTree {
-    private readonly artifact;
-    private contractClass;
+    private readonly privateFunctions;
     private tree?;
     private constructor();
     static create(artifact: ContractArtifact): Promise<PrivateFunctionsTree>;
-    /**
-     * 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.
-     */
-    getFunctionArtifact(selector: FunctionSelector): Promise<import("@aztec/stdlib/abi").FunctionArtifact>;
-    /**
-     * 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.
-     */
-    getBytecode(selector: FunctionSelector): Promise<Buffer>;
-    /**
-     * 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.
-     */
-    getFunctionTreeRoot(): Promise<MerkleTree>;
-    /** Returns the contract class object. */
-    getContractClass(): ContractClassWithId;
-    /** Returns the contract artifact. */
-    getArtifact(): ContractArtifact;
-    /**
-     * Returns the contract class identifier for the given artifact.
-     */
-    getContractClassId(): Fr;
     /**
      * 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
@@ -63,4 +24,4 @@ export declare class PrivateFunctionsTree {
     getFunctionMembershipWitness(selector: FunctionSelector): Promise<MembershipWitness<typeof FUNCTION_TREE_HEIGHT>>;
     private getTree;
 }
-//# sourceMappingURL=private_functions_tree.d.ts.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJpdmF0ZV9mdW5jdGlvbnNfdHJlZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3N0b3JhZ2UvY29udHJhY3RfZGF0YV9wcm92aWRlci9wcml2YXRlX2Z1bmN0aW9uc190cmVlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxvQkFBb0IsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBR3hELE9BQU8sRUFBRSxpQkFBaUIsRUFBbUIsTUFBTSx5QkFBeUIsQ0FBQztBQUM3RSxPQUFPLEVBQUUsS0FBSyxnQkFBZ0IsRUFBRSxnQkFBZ0IsRUFBZ0IsTUFBTSxtQkFBbUIsQ0FBQztBQVExRjs7Ozs7R0FLRztBQUNILHFCQUFhLG9CQUFvQjtJQUdYLE9BQU8sQ0FBQyxRQUFRLENBQUMsZ0JBQWdCO0lBRnJELE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBYTtJQUUxQixPQUFPLGVBQXFFO0lBRTVFLE9BQWEsTUFBTSxDQUFDLFFBQVEsRUFBRSxnQkFBZ0IsaUNBTzdDO0lBRUQ7Ozs7Ozs7O09BUUc7SUFDVSw0QkFBNEIsQ0FDdkMsUUFBUSxFQUFFLGdCQUFnQixHQUN6QixPQUFPLENBQUMsaUJBQWlCLENBQUMsT0FBTyxvQkFBb0IsQ0FBQyxDQUFDLENBZXpEO1lBRWEsT0FBTztDQU10QiJ9

package/dest/storage/contract_data_provider/private_functions_tree.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"private_functions_tree.d.ts","sourceRoot":"","sources":["../../../src/storage/contract_data_provider/private_functions_tree.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAE9C,OAAO,EAAE,iBAAiB,EAAE,KAAK,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC7E,OAAO,EAAE,KAAK,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,EACL,KAAK,mBAAmB,EAIzB,MAAM,wBAAwB,CAAC;AAEhC;;;;;GAKG;AACH,qBAAa,oBAAoB;IAGX,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAAoB,OAAO,CAAC,aAAa;IAFtF,OAAO,CAAC,IAAI,CAAC,CAAa;IAE1B,OAAO;WAEM,MAAM,CAAC,QAAQ,EAAE,gBAAgB;IAK9C;;;;;;;OAOG;IACU,mBAAmB,CAAC,QAAQ,EAAE,gBAAgB;IAkB3D;;;;;;;OAOG;IACU,WAAW,CAAC,QAAQ,EAAE,gBAAgB;IAKnD;;;;;;OAMG;IACI,mBAAmB;IAI1B,yCAAyC;IAClC,gBAAgB;IAIvB,qCAAqC;IAC9B,WAAW;IAIlB;;OAEG;IACI,kBAAkB;IAIzB;;;;;;;;OAQG;IACU,4BAA4B,CACvC,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,iBAAiB,CAAC,OAAO,oBAAoB,CAAC,CAAC;YAiB5C,OAAO;CAOtB"}
+{"version":3,"file":"private_functions_tree.d.ts","sourceRoot":"","sources":["../../../src/storage/contract_data_provider/private_functions_tree.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAGxD,OAAO,EAAE,iBAAiB,EAAmB,MAAM,yBAAyB,CAAC;AAC7E,OAAO,EAAE,KAAK,gBAAgB,EAAE,gBAAgB,EAAgB,MAAM,mBAAmB,CAAC;AAQ1F;;;;;GAKG;AACH,qBAAa,oBAAoB;IAGX,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IAFrD,OAAO,CAAC,IAAI,CAAC,CAAa;IAE1B,OAAO,eAAqE;IAE5E,OAAa,MAAM,CAAC,QAAQ,EAAE,gBAAgB,iCAO7C;IAED;;;;;;;;OAQG;IACU,4BAA4B,CACvC,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,iBAAiB,CAAC,OAAO,oBAAoB,CAAC,CAAC,CAezD;YAEa,OAAO;CAMtB"}

package/dest/storage/contract_data_provider/private_functions_tree.js

@@ -1,74 +1,23 @@
 import { FUNCTION_TREE_HEIGHT } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { assertLength } from '@aztec/foundation/serialize';
 import { MembershipWitness } from '@aztec/foundation/trees';
-import { FunctionSelector } from '@aztec/stdlib/abi';
-import { computePrivateFunctionLeaf, computePrivateFunctionsTree, getContractClassFromArtifact } from '@aztec/stdlib/contract';
+import { FunctionType } from '@aztec/stdlib/abi';
+import { computePrivateFunctionLeaf, computePrivateFunctionsTree, getContractClassPrivateFunctionFromArtifact } 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 {
-    artifact;
-    contractClass;
+    privateFunctions;
     tree;
-    constructor(artifact, contractClass){
-        this.artifact = artifact;
-        this.contractClass = contractClass;
+    constructor(privateFunctions){
+        this.privateFunctions = privateFunctions;
     }
     static async create(artifact) {
-        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.
-   */ async getFunctionArtifact(selector) {
-        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.
-   */ async getBytecode(selector) {
-        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.
-   */ getFunctionTreeRoot() {
-        return this.getTree();
-    }
-    /** Returns the contract class object. */ getContractClass() {
-        return this.contractClass;
-    }
-    /** Returns the contract artifact. */ getArtifact() {
-        return this.artifact;
-    }
-    /**
-   * Returns the contract class identifier for the given artifact.
-   */ getContractClassId() {
-        return this.getContractClass().id;
+        const privateFunctions = await Promise.all(artifact.functions.filter((fn)=>fn.functionType === FunctionType.PRIVATE).map(getContractClassPrivateFunctionFromArtifact));
+        return new PrivateFunctionsTree(privateFunctions);
     }
     /**
    * Retrieve the membership witness of a function within a contract's function tree.
@@ -79,7 +28,7 @@ import { computePrivateFunctionLeaf, computePrivateFunctionsTree, getContractCla
    * @param selector - The function selector.
    * @returns A MembershipWitness instance representing the position and authentication path of the function in the function tree.
    */ async getFunctionMembershipWitness(selector) {
-        const fn = this.getContractClass().privateFunctions.find((f)=>f.selector.equals(selector));
+        const fn = this.privateFunctions.find((f)=>f.selector.equals(selector));
         if (!fn) {
             throw new Error(`Private function with selector ${selector.toString()} not found in contract class.`);
         }
@@ -91,8 +40,7 @@ import { computePrivateFunctionLeaf, computePrivateFunctionsTree, getContractCla
     }
     async getTree() {
         if (!this.tree) {
-            const fns = this.getContractClass().privateFunctions;
-            this.tree = await computePrivateFunctionsTree(fns);
+            this.tree = await computePrivateFunctionsTree(this.privateFunctions);
         }
         return this.tree;
     }

package/dest/storage/index.d.ts

@@ -1,10 +1,9 @@
 export * from './address_data_provider/index.js';
-export * from './auth_witness_data_provider/index.js';
 export * from './capsule_data_provider/index.js';
 export * from './contract_data_provider/index.js';
 export * from './note_data_provider/index.js';
-export * from './sync_data_provider/index.js';
+export * from './anchor_block_data_provider/index.js';
 export * from './tagging_data_provider/index.js';
-export * from './data_provider.js';
-export declare const PXE_DATA_SCHEMA_VERSION = 2;
-//# sourceMappingURL=index.d.ts.map
+export * from './metadata.js';
+export * from './private_event_data_provider/private_event_data_provider.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9zdG9yYWdlL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsa0NBQWtDLENBQUM7QUFDakQsY0FBYyxrQ0FBa0MsQ0FBQztBQUNqRCxjQUFjLG1DQUFtQyxDQUFDO0FBQ2xELGNBQWMsK0JBQStCLENBQUM7QUFDOUMsY0FBYyx1Q0FBdUMsQ0FBQztBQUN0RCxjQUFjLGtDQUFrQyxDQUFDO0FBQ2pELGNBQWMsZUFBZSxDQUFDO0FBQzlCLGNBQWMsOERBQThELENBQUMifQ==

package/dest/storage/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/storage/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC;AACjD,cAAc,uCAAuC,CAAC;AACtD,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,oBAAoB,CAAC;AAEnC,eAAO,MAAM,uBAAuB,IAAI,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/storage/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,uCAAuC,CAAC;AACtD,cAAc,kCAAkC,CAAC;AACjD,cAAc,eAAe,CAAC;AAC9B,cAAc,8DAA8D,CAAC"}

package/dest/storage/index.js

@@ -1,9 +1,8 @@
 export * from './address_data_provider/index.js';
-export * from './auth_witness_data_provider/index.js';
 export * from './capsule_data_provider/index.js';
 export * from './contract_data_provider/index.js';
 export * from './note_data_provider/index.js';
-export * from './sync_data_provider/index.js';
+export * from './anchor_block_data_provider/index.js';
 export * from './tagging_data_provider/index.js';
-export * from './data_provider.js';
-export const PXE_DATA_SCHEMA_VERSION = 2;
+export * from './metadata.js';
+export * from './private_event_data_provider/private_event_data_provider.js';

package/dest/storage/metadata.d.ts

@@ -0,0 +1,2 @@
+export declare const PXE_DATA_SCHEMA_VERSION = 2;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWV0YWRhdGEuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9zdG9yYWdlL21ldGFkYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGVBQU8sTUFBTSx1QkFBdUIsSUFBSSxDQUFDIn0=

package/dest/storage/metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../src/storage/metadata.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,uBAAuB,IAAI,CAAC"}

package/dest/storage/metadata.js

@@ -0,0 +1 @@
+export const PXE_DATA_SCHEMA_VERSION = 2;

package/dest/storage/note_data_provider/index.d.ts

@@ -1,3 +1,3 @@
-export { NoteDao } from './note_dao.js';
+export { NoteDao } from '@aztec/stdlib/note';
 export { NoteDataProvider } from './note_data_provider.js';
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9zdG9yYWdlL25vdGVfZGF0YV9wcm92aWRlci9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsT0FBTyxFQUFFLE1BQU0sb0JBQW9CLENBQUM7QUFDN0MsT0FBTyxFQUFFLGdCQUFnQixFQUFFLE1BQU0seUJBQXlCLENBQUMifQ==

package/dest/storage/note_data_provider/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/storage/note_data_provider/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/storage/note_data_provider/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC"}

package/dest/storage/note_data_provider/index.js

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

package/dest/storage/note_data_provider/note_data_provider.d.ts

@@ -1,20 +1,84 @@
-import type { Fr, Point } from '@aztec/foundation/fields';
+import type { Fr } from '@aztec/foundation/curves/bn254';
 import type { AztecAsyncKVStore } from '@aztec/kv-store';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { InBlock } from '@aztec/stdlib/block';
+import type { DataInBlock } from '@aztec/stdlib/block';
 import { type NotesFilter } from '@aztec/stdlib/note';
-import type { DataProvider } from '../data_provider.js';
-import { NoteDao } from './note_dao.js';
-export declare class NoteDataProvider implements DataProvider {
+import { NoteDao } from '@aztec/stdlib/note';
+/**
+ * NoteDataProvider manages the storage and retrieval of notes.
+ *
+ * Notes can be active or nullified. This class processes new notes, nullifications,
+ * and performs rollback handling in the case of a reorg.
+ **/
+export declare class NoteDataProvider {
     #private;
     private constructor();
+    /**
+     * Creates and initializes a new NoteDataProvider instance.
+     *
+     * This factory method creates a NoteDataProvider and restores any existing
+     * scope-specific indexes from the database.
+     *
+     * @param store - The key-value store to use for persistence
+     * @returns Promise resolving to a fully initialized NoteDataProvider instance
+     */
     static create(store: AztecAsyncKVStore): Promise<NoteDataProvider>;
+    /**
+     * Adds a new scope to the note data provider.
+     *
+     * Scopes provide privacy isolation by creating separate indexes for each user.
+     * Each scope gets its own set of indexes for efficient note retrieval by various criteria.
+     *
+     * @param scope - The AztecAddress representing the scope/user to add
+     * @returns Promise resolving to true if scope was added, false if it already existed
+     */
     addScope(scope: AztecAddress): Promise<boolean>;
-    addNotes(notes: NoteDao[], scope?: AztecAddress): Promise<void>;
-    removeNotesAfter(blockNumber: number): Promise<void>;
-    unnullifyNotesAfter(blockNumber: number, synchedBlockNumber?: number): Promise<void>;
+    /**
+     * Adds multiple notes to the data provider under the specified scope.
+     *
+     * Notes are stored using their index from the notes hash tree as the key, which provides
+     * uniqueness and maintains creation order. Each note is indexed by multiple criteria
+     * for efficient retrieval.
+     *
+     * @param notes - Notes to store
+     * @param scope - The scope (user/account) under which to store the notes
+     */
+    addNotes(notes: NoteDao[], scope: AztecAddress): Promise<void>;
+    /**
+     * Synchronizes notes and nullifiers to a specific block number.
+     *
+     * This method ensures that the state of notes and nullifiers is consistent with the
+     * specified block number. It restores any notes that were nullified after the given block
+     * and deletes any active notes created after that block.
+     *
+     * @param blockNumber - The new chain tip after a reorg
+     * @param synchedBlockNumber - The block number up to which PXE managed to sync before the reorg happened.
+     */
+    rollbackNotesAndNullifiers(blockNumber: number, synchedBlockNumber: number): Promise<void>;
+    /**
+     * Retrieves notes based on the provided filter criteria.
+     *
+     * This method queries both active and optionally nullified notes based on the filter
+     * parameters.
+     *
+     * @param filter - Filter criteria including contractAddress (required), and optional
+     *                 owner, storageSlot, status, scopes, and siloedNullifier.
+     * @returns Filtered and deduplicated notes (a note might be present in multiple scopes - we ensure it is only
+     * returned once if this is the case)
+     * @throws If filtering by an empty scopes array. Scopes have to be set to undefined or to a non-empty array.
+     */
     getNotes(filter: NotesFilter): Promise<NoteDao[]>;
-    removeNullifiedNotes(nullifiers: InBlock<Fr>[], accountAddressPoint: Point): Promise<NoteDao[]>;
-    getSize(): Promise<number>;
+    /**
+     * Transitions notes from "active" to "nullified" state.
+     *
+     * This operation processes a batch of nullifiers to mark the corresponding notes
+     * as spent/nullified.  The operation is atomic - if any nullifier is not found,
+     * the entire operation fails and no notes are modified.
+     *
+     * @param nullifiers - Array of nullifiers with their block numbers to process
+     * @returns Promise resolving to array of nullified NoteDao objects
+     * @throws Error if any nullifier is not found in the active notes
+     */
+    applyNullifiers(nullifiers: DataInBlock<Fr>[]): Promise<NoteDao[]>;
 }
-//# sourceMappingURL=note_data_provider.d.ts.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibm90ZV9kYXRhX3Byb3ZpZGVyLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvc3RvcmFnZS9ub3RlX2RhdGFfcHJvdmlkZXIvbm90ZV9kYXRhX3Byb3ZpZGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUNBLE9BQU8sS0FBSyxFQUFFLEVBQUUsRUFBRSxNQUFNLGdDQUFnQyxDQUFDO0FBRXpELE9BQU8sS0FBSyxFQUFFLGlCQUFpQixFQUFxQyxNQUFNLGlCQUFpQixDQUFDO0FBQzVGLE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUMzRCxPQUFPLEtBQUssRUFBRSxXQUFXLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUN2RCxPQUFPLEVBQWMsS0FBSyxXQUFXLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUNsRSxPQUFPLEVBQUUsT0FBTyxFQUFFLE1BQU0sb0JBQW9CLENBQUM7QUFFN0M7Ozs7O0lBS0k7QUFDSixxQkFBYSxnQkFBZ0I7O0lBaUIzQixPQUFPLGVBZ0JOO0lBRUQ7Ozs7Ozs7O09BUUc7SUFDSCxPQUFvQixNQUFNLENBQUMsS0FBSyxFQUFFLGlCQUFpQixHQUFHLE9BQU8sQ0FBQyxnQkFBZ0IsQ0FBQyxDQU85RTtJQUVEOzs7Ozs7OztPQVFHO0lBQ1UsUUFBUSxDQUFDLEtBQUssRUFBRSxZQUFZLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQVkzRDtJQUVEOzs7Ozs7Ozs7T0FTRztJQUNILFFBQVEsQ0FBQyxLQUFLLEVBQUUsT0FBTyxFQUFFLEVBQUUsS0FBSyxFQUFFLFlBQVksR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBZ0I3RDtJQUVEOzs7Ozs7Ozs7T0FTRztJQUNVLDBCQUEwQixDQUFDLFdBQVcsRUFBRSxNQUFNLEVBQUUsa0JBQWtCLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FHdEc7SUF1RkQ7Ozs7Ozs7Ozs7O09BV0c7SUFDRyxRQUFRLENBQUMsTUFBTSxFQUFFLFdBQVcsR0FBRyxPQUFPLENBQUMsT0FBTyxFQUFFLENBQUMsQ0F3R3REO0lBRUQ7Ozs7Ozs7Ozs7T0FVRztJQUNILGVBQWUsQ0FBQyxVQUFVLEVBQUUsV0FBVyxDQUFDLEVBQUUsQ0FBQyxFQUFFLEdBQUcsT0FBTyxDQUFDLE9BQU8sRUFBRSxDQUFDLENBOERqRTtDQUNGIn0=