@aztec/pxe 0.0.0-test.0 → 0.0.1-commit.24de95ac

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

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;WAEM,MAAM,CAAC,QAAQ,EAAE,gBAAgB;IAS9C;;;;;;;;OAQG;IACU,4BAA4B,CACvC,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,iBAAiB,CAAC,OAAO,oBAAoB,CAAC,CAAC;YAiB5C,OAAO;CAMtB"}

package/dest/storage/contract_data_provider/private_functions_tree.js

@@ -2,73 +2,22 @@ import { FUNCTION_TREE_HEIGHT } from '@aztec/constants';
 import { Fr } from '@aztec/foundation/fields';
 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 './tagging_data_provider/index.js';
-export * from './data_provider.js';
-export declare const PXE_DATA_SCHEMA_VERSION = 2;
+export * from './metadata.js';
+export * from './private_event_data_provider/private_event_data_provider.js';
 //# sourceMappingURL=index.d.ts.map

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,+BAA+B,CAAC;AAC9C,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 './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=metadata.d.ts.map

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/note_dao.d.ts

@@ -1,13 +1,9 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
 import { Fr } from '@aztec/foundation/fields';
 import { BufferReader } from '@aztec/foundation/serialize';
-import type { NoteData } from '@aztec/simulator/client';
-import { NoteSelector } from '@aztec/stdlib/abi';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { PublicKey } from '@aztec/stdlib/keys';
 import { Note } from '@aztec/stdlib/note';
 import { TxHash } from '@aztec/stdlib/tx';
+import type { NoteData } from '../../contract_function_simulator/oracle/interfaces.js';
 /**
  * A Note Data Access Object, representing a note that was committed to the note hash tree, holding all of the
  * information required to use it during execution and manage its state.
@@ -20,10 +16,10 @@ export declare class NoteDao implements NoteData {
     /**
      * The storage location of the note. This value is not used for anything in PXE, but we do index by storage slot
      * since contracts typically make queries based on it.
-     * */
+     */
     storageSlot: Fr;
-    /** The kernel-provided nonce of the note, required to compute the uniqueNoteHash. */
-    nonce: Fr;
+    /** The nonce that was injected into the note hash preimage in order to guarantee uniqueness. */
+    noteNonce: Fr;
     /**
      * The inner hash (non-unique, non-siloed) of the note. Each contract determines how the note is hashed. Can
      * be used alongside contractAddress and nonce to compute the uniqueNoteHash and the siloedNoteHash.
@@ -46,12 +42,11 @@ export declare class NoteDao implements NoteData {
     l2BlockHash: string;
     /** The index of the leaf in the global note hash tree the note is stored at */
     index: bigint;
-    /** The public key with which the note log was encrypted during delivery. */
-    addressPoint: PublicKey;
-    /** The note type identifier for the contract.
-     * TODO(#12013): remove
+    /**
+     * The address whose public key was used to encrypt the note log during delivery.
+     * (This is the x-coordinate of the public key.)
      */
-    noteTypeId: NoteSelector;
+    recipient: AztecAddress;
     constructor(
     /** The packed content of the note, as will be returned in the getNotes oracle. */
     note: Note, 
@@ -60,10 +55,10 @@ export declare class NoteDao implements NoteData {
     /**
      * The storage location of the note. This value is not used for anything in PXE, but we do index by storage slot
      * since contracts typically make queries based on it.
-     * */
+     */
     storageSlot: Fr, 
-    /** The kernel-provided nonce of the note, required to compute the uniqueNoteHash. */
-    nonce: Fr, 
+    /** The nonce that was injected into the note hash preimage in order to guarantee uniqueness. */
+    noteNonce: Fr, 
     /**
      * The inner hash (non-unique, non-siloed) of the note. Each contract determines how the note is hashed. Can
      * be used alongside contractAddress and nonce to compute the uniqueNoteHash and the siloedNoteHash.
@@ -86,12 +81,11 @@ export declare class NoteDao implements NoteData {
     l2BlockHash: string, 
     /** The index of the leaf in the global note hash tree the note is stored at */
     index: bigint, 
-    /** The public key with which the note log was encrypted during delivery. */
-    addressPoint: PublicKey, 
-    /** The note type identifier for the contract.
-     * TODO(#12013): remove
+    /**
+     * The address whose public key was used to encrypt the note log during delivery.
+     * (This is the x-coordinate of the public key.)
      */
-    noteTypeId: NoteSelector);
+    recipient: AztecAddress);
     toBuffer(): Buffer;
     static fromBuffer(buffer: Buffer | BufferReader): NoteDao;
     toString(): string;
@@ -101,6 +95,6 @@ export declare class NoteDao implements NoteData {
      * @returns - Its size in bytes.
      */
     getSize(): number;
-    static random({ note, contractAddress, storageSlot, nonce, noteHash, siloedNullifier, txHash, l2BlockNumber, l2BlockHash, index, addressPoint, noteTypeId, }?: Partial<NoteDao>): Promise<NoteDao>;
+    static random({ note, contractAddress, storageSlot, noteNonce, noteHash, siloedNullifier, txHash, l2BlockNumber, l2BlockHash, index, recipient, }?: Partial<NoteDao>): Promise<NoteDao>;
 }
 //# sourceMappingURL=note_dao.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"note_dao.d.ts","sourceRoot":"","sources":["../../../src/storage/note_data_provider/note_dao.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,EAAE,EAAS,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,YAAY,EAAqB,MAAM,6BAA6B,CAAC;AAC9E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C;;;GAGG;AACH,qBAAa,OAAQ,YAAW,QAAQ;IAIpC,kFAAkF;IAC3E,IAAI,EAAE,IAAI;IACjB,8GAA8G;IACvG,eAAe,EAAE,YAAY;IACpC;;;SAGK;IACE,WAAW,EAAE,EAAE;IACtB,qFAAqF;IAC9E,KAAK,EAAE,EAAE;IAGhB;;;OAGG;IACI,QAAQ,EAAE,EAAE;IACnB;;;OAGG;IACI,eAAe,EAAE,EAAE;IAG1B;;OAEG;IACI,MAAM,EAAE,MAAM;IACrB;gBACY;IACL,aAAa,EAAE,MAAM;IAC5B;gBACY;IACL,WAAW,EAAE,MAAM;IAC1B,+EAA+E;IACxE,KAAK,EAAE,MAAM;IACpB,4EAA4E;IACrE,YAAY,EAAE,SAAS;IAE9B;;OAEG;IACI,UAAU,EAAE,YAAY;;IA3C/B,kFAAkF;IAC3E,IAAI,EAAE,IAAI;IACjB,8GAA8G;IACvG,eAAe,EAAE,YAAY;IACpC;;;SAGK;IACE,WAAW,EAAE,EAAE;IACtB,qFAAqF;IAC9E,KAAK,EAAE,EAAE;IAGhB;;;OAGG;IACI,QAAQ,EAAE,EAAE;IACnB;;;OAGG;IACI,eAAe,EAAE,EAAE;IAG1B;;OAEG;IACI,MAAM,EAAE,MAAM;IACrB;gBACY;IACL,aAAa,EAAE,MAAM;IAC5B;gBACY;IACL,WAAW,EAAE,MAAM;IAC1B,+EAA+E;IACxE,KAAK,EAAE,MAAM;IACpB,4EAA4E;IACrE,YAAY,EAAE,SAAS;IAE9B;;OAEG;IACI,UAAU,EAAE,YAAY;IAGjC,QAAQ,IAAI,MAAM;IAiBlB,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY;IAgC/C,QAAQ;IAIR,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM;IAK7B;;;OAGG;IACI,OAAO;WAMD,MAAM,CAAC,EAClB,IAAoB,EACpB,eAA2B,EAC3B,WAAyB,EACzB,KAAmB,EACnB,QAAsB,EACtB,eAA6B,EAC7B,MAAwB,EACxB,aAAgD,EAChD,WAAoC,EACpC,KAA8B,EAC9B,YAAwB,EACxB,UAAkC,GACnC,GAAE,OAAO,CAAC,OAAO,CAAM;CAgBzB"}
+{"version":3,"file":"note_dao.d.ts","sourceRoot":"","sources":["../../../src/storage/note_data_provider/note_dao.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAS,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,YAAY,EAAqB,MAAM,6BAA6B,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wDAAwD,CAAC;AAEvF;;;GAGG;AACH,qBAAa,OAAQ,YAAW,QAAQ;IAIpC,kFAAkF;IAC3E,IAAI,EAAE,IAAI;IACjB,8GAA8G;IACvG,eAAe,EAAE,YAAY;IACpC;;;OAGG;IACI,WAAW,EAAE,EAAE;IACtB,gGAAgG;IACzF,SAAS,EAAE,EAAE;IAGpB;;;OAGG;IACI,QAAQ,EAAE,EAAE;IACnB;;;OAGG;IACI,eAAe,EAAE,EAAE;IAG1B;;OAEG;IACI,MAAM,EAAE,MAAM;IACrB;gBACY;IACL,aAAa,EAAE,MAAM;IAC5B;gBACY;IACL,WAAW,EAAE,MAAM;IAC1B,+EAA+E;IACxE,KAAK,EAAE,MAAM;IACpB;;;OAGG;IACI,SAAS,EAAE,YAAY;;IAzC9B,kFAAkF;IAC3E,IAAI,EAAE,IAAI;IACjB,8GAA8G;IACvG,eAAe,EAAE,YAAY;IACpC;;;OAGG;IACI,WAAW,EAAE,EAAE;IACtB,gGAAgG;IACzF,SAAS,EAAE,EAAE;IAGpB;;;OAGG;IACI,QAAQ,EAAE,EAAE;IACnB;;;OAGG;IACI,eAAe,EAAE,EAAE;IAG1B;;OAEG;IACI,MAAM,EAAE,MAAM;IACrB;gBACY;IACL,aAAa,EAAE,MAAM;IAC5B;gBACY;IACL,WAAW,EAAE,MAAM;IAC1B,+EAA+E;IACxE,KAAK,EAAE,MAAM;IACpB;;;OAGG;IACI,SAAS,EAAE,YAAY;IAGhC,QAAQ,IAAI,MAAM;IAgBlB,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY;IA8B/C,QAAQ;IAIR,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM;IAK7B;;;OAGG;IACI,OAAO;WAMD,MAAM,CAAC,EAClB,IAAoB,EACpB,eAA2B,EAC3B,WAAyB,EACzB,SAAuB,EACvB,QAAsB,EACtB,eAA6B,EAC7B,MAAwB,EACxB,aAAgD,EAChD,WAAoC,EACpC,KAA8B,EAC9B,SAAqB,GACtB,GAAE,OAAO,CAAC,OAAO,CAAM;CAezB"}

package/dest/storage/note_data_provider/note_dao.js

@@ -1,7 +1,6 @@
 import { toBigIntBE } from '@aztec/foundation/bigint-buffer';
 import { Fr, Point } from '@aztec/foundation/fields';
 import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
-import { NoteSelector } from '@aztec/stdlib/abi';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { Note } from '@aztec/stdlib/note';
 import { TxHash } from '@aztec/stdlib/tx';
@@ -12,20 +11,19 @@ import { TxHash } from '@aztec/stdlib/tx';
     note;
     contractAddress;
     storageSlot;
-    nonce;
+    noteNonce;
     noteHash;
     siloedNullifier;
     txHash;
     l2BlockNumber;
     l2BlockHash;
     index;
-    addressPoint;
-    noteTypeId;
+    recipient;
     constructor(// Note information
     /** The packed content of the note, as will be returned in the getNotes oracle. */ note, /** The address of the contract that created the note (i.e. the address used by the kernel during siloing). */ contractAddress, /**
      * The storage location of the note. This value is not used for anything in PXE, but we do index by storage slot
      * since contracts typically make queries based on it.
-     * */ storageSlot, /** The kernel-provided nonce of the note, required to compute the uniqueNoteHash. */ nonce, // Computed values
+     */ storageSlot, /** The nonce that was injected into the note hash preimage in order to guarantee uniqueness. */ noteNonce, // Computed values
     /**
      * The inner hash (non-unique, non-siloed) of the note. Each contract determines how the note is hashed. Can
      * be used alongside contractAddress and nonce to compute the uniqueNoteHash and the siloedNoteHash.
@@ -37,36 +35,35 @@ import { TxHash } from '@aztec/stdlib/tx';
      *  when searching for txEffects.
      */ txHash, /** The L2 block number in which the tx with this note was included. Used for note management while processing
      * reorgs.*/ l2BlockNumber, /** The L2 block hash in which the tx with this note was included. Used for note management while processing
-     * reorgs.*/ l2BlockHash, /** The index of the leaf in the global note hash tree the note is stored at */ index, /** The public key with which the note log was encrypted during delivery. */ addressPoint, /** The note type identifier for the contract.
-     * TODO(#12013): remove
-     */ noteTypeId){
+     * reorgs.*/ l2BlockHash, /** The index of the leaf in the global note hash tree the note is stored at */ index, /**
+     * The address whose public key was used to encrypt the note log during delivery.
+     * (This is the x-coordinate of the public key.)
+     */ recipient){
         this.note = note;
         this.contractAddress = contractAddress;
         this.storageSlot = storageSlot;
-        this.nonce = nonce;
+        this.noteNonce = noteNonce;
         this.noteHash = noteHash;
         this.siloedNullifier = siloedNullifier;
         this.txHash = txHash;
         this.l2BlockNumber = l2BlockNumber;
         this.l2BlockHash = l2BlockHash;
         this.index = index;
-        this.addressPoint = addressPoint;
-        this.noteTypeId = noteTypeId;
+        this.recipient = recipient;
     }
     toBuffer() {
         return serializeToBuffer([
             this.note,
             this.contractAddress,
             this.storageSlot,
-            this.nonce,
+            this.noteNonce,
             this.noteHash,
             this.siloedNullifier,
             this.txHash,
             this.l2BlockNumber,
             Fr.fromHexString(this.l2BlockHash),
             this.index,
-            this.addressPoint,
-            this.noteTypeId
+            this.recipient
         ]);
     }
     static fromBuffer(buffer) {
@@ -74,16 +71,15 @@ import { TxHash } from '@aztec/stdlib/tx';
         const note = Note.fromBuffer(reader);
         const contractAddress = AztecAddress.fromBuffer(reader);
         const storageSlot = Fr.fromBuffer(reader);
-        const nonce = Fr.fromBuffer(reader);
+        const noteNonce = Fr.fromBuffer(reader);
         const noteHash = Fr.fromBuffer(reader);
         const siloedNullifier = Fr.fromBuffer(reader);
         const txHash = reader.readObject(TxHash);
         const l2BlockNumber = reader.readNumber();
         const l2BlockHash = Fr.fromBuffer(reader).toString();
         const index = toBigIntBE(reader.readBytes(32));
-        const publicKey = Point.fromBuffer(reader);
-        const noteTypeId = reader.readObject(NoteSelector);
-        return new NoteDao(note, contractAddress, storageSlot, nonce, noteHash, siloedNullifier, txHash, l2BlockNumber, l2BlockHash, index, publicKey, noteTypeId);
+        const recipient = AztecAddress.fromBuffer(reader);
+        return new NoteDao(note, contractAddress, storageSlot, noteNonce, noteHash, siloedNullifier, txHash, l2BlockNumber, l2BlockHash, index, recipient);
     }
     toString() {
         return '0x' + this.toBuffer().toString('hex');
@@ -100,7 +96,7 @@ import { TxHash } from '@aztec/stdlib/tx';
         const noteSize = 4 + this.note.items.length * Fr.SIZE_IN_BYTES;
         return noteSize + AztecAddress.SIZE_IN_BYTES + Fr.SIZE_IN_BYTES * 4 + TxHash.SIZE + Point.SIZE_IN_BYTES + indexSize;
     }
-    static async random({ note = Note.random(), contractAddress = undefined, storageSlot = Fr.random(), nonce = Fr.random(), noteHash = Fr.random(), siloedNullifier = Fr.random(), txHash = TxHash.random(), l2BlockNumber = Math.floor(Math.random() * 1000), l2BlockHash = Fr.random().toString(), index = Fr.random().toBigInt(), addressPoint = undefined, noteTypeId = NoteSelector.random() } = {}) {
-        return new NoteDao(note, contractAddress ?? await AztecAddress.random(), storageSlot, nonce, noteHash, siloedNullifier, txHash, l2BlockNumber, l2BlockHash, index, addressPoint ?? await Point.random(), noteTypeId);
+    static async random({ note = Note.random(), contractAddress = undefined, storageSlot = Fr.random(), noteNonce = Fr.random(), noteHash = Fr.random(), siloedNullifier = Fr.random(), txHash = TxHash.random(), l2BlockNumber = Math.floor(Math.random() * 1000), l2BlockHash = Fr.random().toString(), index = Fr.random().toBigInt(), recipient = undefined } = {}) {
+        return new NoteDao(note, contractAddress ?? await AztecAddress.random(), storageSlot, noteNonce, noteHash, siloedNullifier, txHash, l2BlockNumber, l2BlockHash, index, recipient ?? await AztecAddress.random());
     }
 }

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

@@ -1,20 +1,83 @@
-import type { Fr, Point } from '@aztec/foundation/fields';
+import type { Fr } from '@aztec/foundation/fields';
 import type { AztecAsyncKVStore } from '@aztec/kv-store';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { InBlock } 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 {
+/**
+ * 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
+     *                 storageSlot, status, scopes and siloedNullifier.
+     * @returns Promise resolving to array of NoteDao objects matching the filter
+     * @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: InBlock<Fr>[]): Promise<NoteDao[]>;
 }
 //# sourceMappingURL=note_data_provider.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"note_data_provider.d.ts","sourceRoot":"","sources":["../../../src/storage/note_data_provider/note_data_provider.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAC;AAE1D,OAAO,KAAK,EAAE,iBAAiB,EAAqC,MAAM,iBAAiB,CAAC;AAC5F,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EAAc,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAElE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,qBAAa,gBAAiB,YAAW,YAAY;;IAsBnD,OAAO;WAsBa,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAWlE,QAAQ,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAmBtD,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,KAAK,GAAE,YAAgC,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBjF,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsB9C,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkD3F,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAkGvD,oBAAoB,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,CAAC,EAAE,EAAE,mBAAmB,EAAE,KAAK,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IA6DzF,OAAO;CAGd"}
+{"version":3,"file":"note_data_provider.d.ts","sourceRoot":"","sources":["../../../src/storage/note_data_provider/note_data_provider.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAEnD,OAAO,KAAK,EAAE,iBAAiB,EAAqC,MAAM,iBAAiB,CAAC;AAC5F,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAc,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAElE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC;;;;;IAKI;AACJ,qBAAa,gBAAgB;;IAiB3B,OAAO;IAkBP;;;;;;;;OAQG;WACiB,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAS/E;;;;;;;;OAQG;IACU,QAAQ,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAc5D;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB9D;;;;;;;;;OASG;IACU,0BAA0B,CAAC,WAAW,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAwFvG;;;;;;;;;;OAUG;IACG,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IA8FvD;;;;;;;;;;OAUG;IACH,eAAe,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;CA0D/D"}