@aztec/pxe 0.0.0-test.1 → 0.0.1-commit.017a351

package/dest/contract_function_simulator/pick_notes.d.ts

@@ -0,0 +1,85 @@
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { Comparator, type Note } from '@aztec/stdlib/note';
+export interface PropertySelector {
+    index: number;
+    offset: number;
+    length: number;
+}
+/**
+ * Configuration for selecting values.
+ */
+export interface Select {
+    /**
+     * Selector of the field to select and match.
+     */
+    selector: PropertySelector;
+    /**
+     * Required value of the field.
+     */
+    value: Fr;
+    /**
+     * The comparator to use
+     */
+    comparator: Comparator;
+}
+/**
+ * The order to sort an array.
+ */
+export declare enum SortOrder {
+    NADA = 0,
+    DESC = 1,
+    ASC = 2
+}
+/**
+ * Configuration for sorting values.
+ */
+export interface Sort {
+    /**
+     * Selector of the field to sort.
+     */
+    selector: PropertySelector;
+    /**
+     * Order to sort the field.
+     */
+    order: SortOrder;
+}
+/**
+ * Options for picking items from an array of BasicNoteData.
+ */
+interface GetOptions {
+    /**
+     * Configurations for selecting items.
+     * Default: empty array.
+     */
+    selects?: Select[];
+    /**
+     * Configurations for sorting items.
+     * Default: empty array.
+     */
+    sorts?: Sort[];
+    /**
+     * The number of items to retrieve per query.
+     * Default: 0. No limit.
+     */
+    limit?: number;
+    /**
+     * The starting index for pagination.
+     * Default: 0.
+     */
+    offset?: number;
+}
+/**
+ * Data needed from to perform sort.
+ */
+interface ContainsNote {
+    /**
+     * The note.
+     */
+    note: Note;
+}
+/**
+ * Pick from a note array a number of notes that meet the criteria.
+ */
+export declare function pickNotes<T extends ContainsNote>(noteDatas: T[], { selects, sorts, limit, offset }: GetOptions): T[];
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGlja19ub3Rlcy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnRyYWN0X2Z1bmN0aW9uX3NpbXVsYXRvci9waWNrX25vdGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxFQUFFLEVBQUUsTUFBTSxnQ0FBZ0MsQ0FBQztBQUNwRCxPQUFPLEVBQUUsVUFBVSxFQUFFLEtBQUssSUFBSSxFQUFFLE1BQU0sb0JBQW9CLENBQUM7QUFFM0QsTUFBTSxXQUFXLGdCQUFnQjtJQUMvQixLQUFLLEVBQUUsTUFBTSxDQUFDO0lBQ2QsTUFBTSxFQUFFLE1BQU0sQ0FBQztJQUNmLE1BQU0sRUFBRSxNQUFNLENBQUM7Q0FDaEI7QUFFRDs7R0FFRztBQUNILE1BQU0sV0FBVyxNQUFNO0lBQ3JCOztPQUVHO0lBQ0gsUUFBUSxFQUFFLGdCQUFnQixDQUFDO0lBQzNCOztPQUVHO0lBQ0gsS0FBSyxFQUFFLEVBQUUsQ0FBQztJQUNWOztPQUVHO0lBQ0gsVUFBVSxFQUFFLFVBQVUsQ0FBQztDQUN4QjtBQUVEOztHQUVHO0FBQ0gsb0JBQVksU0FBUztJQUNuQixJQUFJLElBQUk7SUFDUixJQUFJLElBQUk7SUFDUixHQUFHLElBQUk7Q0FDUjtBQUVEOztHQUVHO0FBQ0gsTUFBTSxXQUFXLElBQUk7SUFDbkI7O09BRUc7SUFDSCxRQUFRLEVBQUUsZ0JBQWdCLENBQUM7SUFDM0I7O09BRUc7SUFDSCxLQUFLLEVBQUUsU0FBUyxDQUFDO0NBQ2xCO0FBRUQ7O0dBRUc7QUFDSCxVQUFVLFVBQVU7SUFDbEI7OztPQUdHO0lBQ0gsT0FBTyxDQUFDLEVBQUUsTUFBTSxFQUFFLENBQUM7SUFDbkI7OztPQUdHO0lBQ0gsS0FBSyxDQUFDLEVBQUUsSUFBSSxFQUFFLENBQUM7SUFDZjs7O09BR0c7SUFDSCxLQUFLLENBQUMsRUFBRSxNQUFNLENBQUM7SUFDZjs7O09BR0c7SUFDSCxNQUFNLENBQUMsRUFBRSxNQUFNLENBQUM7Q0FDakI7QUFFRDs7R0FFRztBQUNILFVBQVUsWUFBWTtJQUNwQjs7T0FFRztJQUNILElBQUksRUFBRSxJQUFJLENBQUM7Q0FDWjtBQWlFRDs7R0FFRztBQUNILHdCQUFnQixTQUFTLENBQUMsQ0FBQyxTQUFTLFlBQVksRUFDOUMsU0FBUyxFQUFFLENBQUMsRUFBRSxFQUNkLEVBQUUsT0FBWSxFQUFFLEtBQVUsRUFBRSxLQUFTLEVBQUUsTUFBVSxFQUFFLEVBQUUsVUFBVSxHQUM5RCxDQUFDLEVBQUUsQ0FJTCJ9

package/dest/contract_function_simulator/pick_notes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pick_notes.d.ts","sourceRoot":"","sources":["../../src/contract_function_simulator/pick_notes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,KAAK,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAC;IAC3B;;OAEG;IACH,KAAK,EAAE,EAAE,CAAC;IACV;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;CACxB;AAED;;GAEG;AACH,oBAAY,SAAS;IACnB,IAAI,IAAI;IACR,IAAI,IAAI;IACR,GAAG,IAAI;CACR;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAC;IAC3B;;OAEG;IACH,KAAK,EAAE,SAAS,CAAC;CAClB;AAED;;GAEG;AACH,UAAU,UAAU;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;;OAGG;IACH,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;IACf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,UAAU,YAAY;IACpB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;CACZ;AAiED;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,YAAY,EAC9C,SAAS,EAAE,CAAC,EAAE,EACd,EAAE,OAAY,EAAE,KAAU,EAAE,KAAS,EAAE,MAAU,EAAE,EAAE,UAAU,GAC9D,CAAC,EAAE,CAIL"}

package/dest/contract_function_simulator/pick_notes.js

@@ -0,0 +1,68 @@
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { Comparator } from '@aztec/stdlib/note';
+/**
+ * The order to sort an array.
+ */ export var SortOrder = /*#__PURE__*/ function(SortOrder) {
+    SortOrder[SortOrder["NADA"] = 0] = "NADA";
+    SortOrder[SortOrder["DESC"] = 1] = "DESC";
+    SortOrder[SortOrder["ASC"] = 2] = "ASC";
+    return SortOrder;
+}({});
+const selectPropertyFromPackedNoteContent = (noteData, selector)=>{
+    if (selector.index >= noteData.length) {
+        throw new Error(`Property selector index ${selector.index} out of bounds for note with ${noteData.length} fields`);
+    }
+    if (selector.offset + selector.length > Fr.SIZE_IN_BYTES) {
+        throw new Error(`Property selector range (offset=${selector.offset}, length=${selector.length}) exceeds Fr buffer size of ${Fr.SIZE_IN_BYTES} bytes`);
+    }
+    const noteValueBuffer = noteData[selector.index].toBuffer();
+    // Noir's PropertySelector counts offset from the LSB (last byte of the big-endian buffer),
+    // so offset=0,length=Fr.SIZE_IN_BYTES reads the entire field, and offset=0,length=1 reads the last byte.
+    const start = Fr.SIZE_IN_BYTES - selector.offset - selector.length;
+    const end = Fr.SIZE_IN_BYTES - selector.offset;
+    const noteValue = noteValueBuffer.subarray(start, end);
+    // Left-pad to Fr.SIZE_IN_BYTES so Fr.fromBuffer interprets the value correctly.
+    const padded = Buffer.alloc(Fr.SIZE_IN_BYTES);
+    noteValue.copy(padded, Fr.SIZE_IN_BYTES - noteValue.length);
+    return Fr.fromBuffer(padded);
+};
+const selectNotes = (noteDatas, selects)=>noteDatas.filter((noteData)=>selects.every(({ selector, value, comparator })=>{
+            const noteValueFr = selectPropertyFromPackedNoteContent(noteData.note.items, selector);
+            const comparatorSelector = {
+                [Comparator.EQ]: ()=>noteValueFr.equals(value),
+                [Comparator.NEQ]: ()=>!noteValueFr.equals(value),
+                [Comparator.LT]: ()=>noteValueFr.lt(value),
+                [Comparator.LTE]: ()=>noteValueFr.lt(value) || noteValueFr.equals(value),
+                [Comparator.GT]: ()=>!noteValueFr.lt(value) && !noteValueFr.equals(value),
+                [Comparator.GTE]: ()=>!noteValueFr.lt(value)
+            };
+            const fn = comparatorSelector[comparator];
+            if (!fn) {
+                throw new Error(`Invalid comparator value: ${comparator}`);
+            }
+            return fn();
+        }));
+const sortNotes = (a, b, sorts, level = 0)=>{
+    if (sorts[level] === undefined) {
+        return 0;
+    }
+    const { selector, order } = sorts[level];
+    if (order === 0) {
+        return 0;
+    }
+    const aValue = selectPropertyFromPackedNoteContent(a, selector);
+    const bValue = selectPropertyFromPackedNoteContent(b, selector);
+    const dir = order === 1 ? [
+        -1,
+        1
+    ] : [
+        1,
+        -1
+    ];
+    return aValue.toBigInt() === bValue.toBigInt() ? sortNotes(a, b, sorts, level + 1) : aValue.toBigInt() > bValue.toBigInt() ? dir[0] : dir[1];
+};
+/**
+ * Pick from a note array a number of notes that meet the criteria.
+ */ export function pickNotes(noteDatas, { selects = [], sorts = [], limit = 0, offset = 0 }) {
+    return selectNotes(noteDatas, selects).sort((a, b)=>sortNotes(a.note.items, b.note.items, sorts)).slice(offset, limit ? offset + limit : undefined);
+}

package/dest/contract_function_simulator/proxied_contract_data_source.d.ts

@@ -0,0 +1,6 @@
+import type { ContractOverrides } from '@aztec/stdlib/tx';
+import type { ContractStore } from '../storage/contract_store/contract_store.js';
+export declare class ProxiedContractStoreFactory {
+    static create(contractStore: ContractStore, overrides?: ContractOverrides): ContractStore;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJveGllZF9jb250cmFjdF9kYXRhX3NvdXJjZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnRyYWN0X2Z1bmN0aW9uX3NpbXVsYXRvci9wcm94aWVkX2NvbnRyYWN0X2RhdGFfc291cmNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBLE9BQU8sS0FBSyxFQUFFLGlCQUFpQixFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFFMUQsT0FBTyxLQUFLLEVBQUUsYUFBYSxFQUFFLE1BQU0sNkNBQTZDLENBQUM7QUFjakYscUJBQWEsMkJBQTJCO0lBQ3RDLE1BQU0sQ0FBQyxNQUFNLENBQUMsYUFBYSxFQUFFLGFBQWEsRUFBRSxTQUFTLENBQUMsRUFBRSxpQkFBaUIsaUJBdUN4RTtDQUNGIn0=

package/dest/contract_function_simulator/proxied_contract_data_source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxied_contract_data_source.d.ts","sourceRoot":"","sources":["../../src/contract_function_simulator/proxied_contract_data_source.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6CAA6C,CAAC;AAcjF,qBAAa,2BAA2B;IACtC,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,aAAa,EAAE,SAAS,CAAC,EAAE,iBAAiB,iBAuCxE;CACF"}

package/dest/contract_function_simulator/proxied_contract_data_source.js

@@ -0,0 +1,51 @@
+import { findFunctionArtifactBySelector } from '@aztec/stdlib/abi';
+/*
+ * Proxy generator for a ContractStore that allows overriding contract instances at given addresses,
+ * so the contract function simulator can execute different bytecode on certain addresses. An example
+ * use case would be overriding your own account contract so that valid signatures don't have to be
+ * provided while simulating.
+ *
+ * Function artifact lookups for an overridden address are routed via the override-instance's
+ * `currentContractClassId` rather than the underlying ContractStore's address→class mapping —
+ * `ContractStore.getFunctionArtifact` calls `this.getContractInstance` internally, which the proxy
+ * cannot intercept (the binding sees the raw target, not the proxy). The target class must be
+ * registered ahead of time via `pxe.registerContractClass(...)`.
+ */ export class ProxiedContractStoreFactory {
+    static create(contractStore, overrides) {
+        if (!overrides) {
+            return contractStore;
+        }
+        return new Proxy(contractStore, {
+            get (target, prop) {
+                if (prop === 'getContractInstance') {
+                    return (address)=>{
+                        const override = overrides[address.toString()];
+                        return override ? Promise.resolve(override.instance) : target.getContractInstance(address);
+                    };
+                }
+                if (prop === 'getFunctionArtifact' || prop === 'getFunctionArtifactWithDebugMetadata') {
+                    return async (contractAddress, selector)=>{
+                        const override = overrides[contractAddress.toString()];
+                        if (!override) {
+                            return target[prop].call(target, contractAddress, selector);
+                        }
+                        const artifact = await target.getContractArtifact(override.instance.currentContractClassId);
+                        if (!artifact) {
+                            throw new Error(`No artifact registered for override class ${override.instance.currentContractClassId} ` + `at ${contractAddress}. Register it via pxe.registerContractClass(...) before simulating.`);
+                        }
+                        const fn = await findFunctionArtifactBySelector(artifact, selector);
+                        if (!fn) {
+                            throw new Error(`Function with selector ${selector} not found in stub artifact for overridden contract at ${contractAddress}.`);
+                        }
+                        return {
+                            ...fn,
+                            contractName: artifact.name
+                        };
+                    };
+                }
+                const value = Reflect.get(target, prop);
+                return typeof value === 'function' ? value.bind(target) : value;
+            }
+        });
+    }
+}

package/dest/contract_logging.d.ts

@@ -0,0 +1,27 @@
+import type { Fr } from '@aztec/foundation/curves/bn254';
+import { type LogLevel, type Logger } from '@aztec/foundation/log';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { DebugLog } from '@aztec/stdlib/logs';
+/** Resolves a contract address to a human-readable name, if available. */
+export type ContractNameResolver = (address: AztecAddress) => Promise<string | undefined>;
+export type CONTRACT_LOG_KIND = 'aztecnr' | 'user';
+/**
+ * Creates a logger whose output is prefixed with `contract:<name>(<addrAbbrev>)`.
+ */
+export declare function createContractLogger(contractAddress: AztecAddress, getContractName: ContractNameResolver, kind: CONTRACT_LOG_KIND, options?: {
+    instanceId?: string;
+}): Promise<Logger>;
+/**
+ * Formats and emits a single contract log message through the given logger.
+ */
+export declare function logContractMessage(logger: Logger, level: LogLevel, message: string, fields: Fr[]): void;
+/**
+ * Displays debug logs collected during public function simulation,
+ * using the `contract:` prefixed logger format.
+ */
+export declare function displayDebugLogs(debugLogs: DebugLog[], getContractName: ContractNameResolver): Promise<void>;
+export declare function stripAztecnrLogPrefix(message: string): {
+    kind: CONTRACT_LOG_KIND;
+    message: string;
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udHJhY3RfbG9nZ2luZy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NvbnRyYWN0X2xvZ2dpbmcudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsRUFBRSxFQUFFLE1BQU0sZ0NBQWdDLENBQUM7QUFDekQsT0FBTyxFQUFFLEtBQUssUUFBUSxFQUFFLEtBQUssTUFBTSxFQUF1QyxNQUFNLHVCQUF1QixDQUFDO0FBQ3hHLE9BQU8sS0FBSyxFQUFFLFlBQVksRUFBRSxNQUFNLDZCQUE2QixDQUFDO0FBQ2hFLE9BQU8sS0FBSyxFQUFFLFFBQVEsRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBRW5ELDBFQUEwRTtBQUMxRSxNQUFNLE1BQU0sb0JBQW9CLEdBQUcsQ0FBQyxPQUFPLEVBQUUsWUFBWSxLQUFLLE9BQU8sQ0FBQyxNQUFNLEdBQUcsU0FBUyxDQUFDLENBQUM7QUFDMUYsTUFBTSxNQUFNLGlCQUFpQixHQUFHLFNBQVMsR0FBRyxNQUFNLENBQUM7QUFFbkQ7O0dBRUc7QUFDSCx3QkFBc0Isb0JBQW9CLENBQ3hDLGVBQWUsRUFBRSxZQUFZLEVBQzdCLGVBQWUsRUFBRSxvQkFBb0IsRUFDckMsSUFBSSxFQUFFLGlCQUFpQixFQUN2QixPQUFPLENBQUMsRUFBRTtJQUFFLFVBQVUsQ0FBQyxFQUFFLE1BQU0sQ0FBQTtDQUFFLEdBQ2hDLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FPakI7QUFFRDs7R0FFRztBQUNILHdCQUFnQixrQkFBa0IsQ0FBQyxNQUFNLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxRQUFRLEVBQUUsT0FBTyxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsRUFBRSxFQUFFLEdBQUcsSUFBSSxDQUV2RztBQUVEOzs7R0FHRztBQUNILHdCQUFzQixnQkFBZ0IsQ0FBQyxTQUFTLEVBQUUsUUFBUSxFQUFFLEVBQUUsZUFBZSxFQUFFLG9CQUFvQixHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FNbEg7QUFFRCx3QkFBZ0IscUJBQXFCLENBQUMsT0FBTyxFQUFFLE1BQU0sR0FBRztJQUFFLElBQUksRUFBRSxpQkFBaUIsQ0FBQztJQUFDLE9BQU8sRUFBRSxNQUFNLENBQUE7Q0FBRSxDQU1uRyJ9

package/dest/contract_logging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract_logging.d.ts","sourceRoot":"","sources":["../src/contract_logging.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,MAAM,EAAuC,MAAM,uBAAuB,CAAC;AACxG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEnD,0EAA0E;AAC1E,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,EAAE,YAAY,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;AAC1F,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,MAAM,CAAC;AAEnD;;GAEG;AACH,wBAAsB,oBAAoB,CACxC,eAAe,EAAE,YAAY,EAC7B,eAAe,EAAE,oBAAoB,EACrC,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,GAChC,OAAO,CAAC,MAAM,CAAC,CAOjB;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,IAAI,CAEvG;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,eAAe,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAMlH;AAED,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG;IAAE,IAAI,EAAE,iBAAiB,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAMnG"}

package/dest/contract_logging.js

@@ -0,0 +1,38 @@
+import { applyStringFormatting, createLogger } from '@aztec/foundation/log';
+/**
+ * Creates a logger whose output is prefixed with `contract:<name>(<addrAbbrev>)`.
+ */ export async function createContractLogger(contractAddress, getContractName, kind, options) {
+    const addrAbbrev = contractAddress.toString().slice(0, 10);
+    const name = await getContractName(contractAddress);
+    const prefix = kind == 'aztecnr' ? 'aztecnr' : 'contract';
+    const module = name ? `${prefix}:${name}(${addrAbbrev})` : `${prefix}:Unknown(${addrAbbrev})`;
+    return createLogger(module, options);
+}
+/**
+ * Formats and emits a single contract log message through the given logger.
+ */ export function logContractMessage(logger, level, message, fields) {
+    logger[level](applyStringFormatting(message, fields));
+}
+/**
+ * Displays debug logs collected during public function simulation,
+ * using the `contract:` prefixed logger format.
+ */ export async function displayDebugLogs(debugLogs, getContractName) {
+    for (const log of debugLogs){
+        const { kind, message } = stripAztecnrLogPrefix(log.message);
+        const logger = await createContractLogger(log.contractAddress, getContractName, kind);
+        logContractMessage(logger, log.level, message, log.fields);
+    }
+}
+export function stripAztecnrLogPrefix(message) {
+    if (message.startsWith('[aztec-nr] ')) {
+        return {
+            kind: 'aztecnr',
+            message: message.slice('[aztec-nr] '.length)
+        };
+    } else {
+        return {
+            kind: 'user',
+            message
+        };
+    }
+}

package/dest/contract_sync/contract_sync_service.d.ts

@@ -0,0 +1,42 @@
+import type { Logger } from '@aztec/foundation/log';
+import type { FunctionCall, FunctionSelector } from '@aztec/stdlib/abi';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+import type { BlockHeader } from '@aztec/stdlib/tx';
+import type { StagedStore } from '../job_coordinator/job_coordinator.js';
+import type { ContractStore } from '../storage/contract_store/contract_store.js';
+import type { NoteStore } from '../storage/note_store/note_store.js';
+/**
+ * Service for syncing the private state of contracts and verifying that the PXE holds the current class artifact.
+ * It uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
+ *
+ * TODO: The StagedStore naming is broken here. Figure out a better name.
+ */
+export declare class ContractSyncService implements StagedStore {
+    #private;
+    private aztecNode;
+    private contractStore;
+    private noteStore;
+    private log;
+    readonly storeName = "contract_sync";
+    private syncedContracts;
+    private classIdVerificationCache;
+    constructor(aztecNode: AztecNode, contractStore: ContractStore, noteStore: NoteStore, log: Logger);
+    /**
+     * Ensures a contract's private state is synchronized and that the PXE holds the current class artifact.
+     * Uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
+     * @param contractAddress - The address of the contract to sync.
+     * @param functionToInvokeAfterSync - The function selector that will be called after sync (used to validate it's
+     * not sync_state itself).
+     * @param utilityExecutor - Executor function for running the sync_state utility function.
+     * @param scopes - Access scopes to pass through to the utility executor (affects whose account's private state is discovered).
+     */
+    ensureContractSynced(contractAddress: AztecAddress, functionToInvokeAfterSync: FunctionSelector | null, utilityExecutor: (call: FunctionCall, scopes: AztecAddress[]) => Promise<any>, anchorBlockHeader: BlockHeader, jobId: string, scopes: AztecAddress[]): Promise<void>;
+    /** Clears sync cache entries for the given scopes of a contract. */
+    invalidateContractForScopes(contractAddress: AztecAddress, scopes: AztecAddress[]): void;
+    /** Clears sync cache. Called by BlockSynchronizer when anchor block changes. */
+    wipe(): void;
+    commit(_jobId: string): Promise<void>;
+    discardStaged(_jobId: string): Promise<void>;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udHJhY3Rfc3luY19zZXJ2aWNlLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29udHJhY3Rfc3luYy9jb250cmFjdF9zeW5jX3NlcnZpY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFHcEQsT0FBTyxLQUFLLEVBQUUsWUFBWSxFQUFFLGdCQUFnQixFQUFFLE1BQU0sbUJBQW1CLENBQUM7QUFDeEUsT0FBTyxLQUFLLEVBQUUsWUFBWSxFQUFFLE1BQU0sNkJBQTZCLENBQUM7QUFDaEUsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFDakUsT0FBTyxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFFcEQsT0FBTyxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0sdUNBQXVDLENBQUM7QUFFekUsT0FBTyxLQUFLLEVBQUUsYUFBYSxFQUFFLE1BQU0sNkNBQTZDLENBQUM7QUFDakYsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0scUNBQXFDLENBQUM7QUFNckU7Ozs7O0dBS0c7QUFDSCxxQkFBYSxtQkFBb0IsWUFBVyxXQUFXOztJQWtCbkQsT0FBTyxDQUFDLFNBQVM7SUFDakIsT0FBTyxDQUFDLGFBQWE7SUFDckIsT0FBTyxDQUFDLFNBQVM7SUFDakIsT0FBTyxDQUFDLEdBQUc7SUFwQmIsUUFBUSxDQUFDLFNBQVMsbUJBQW1CO0lBS3JDLE9BQU8sQ0FBQyxlQUFlLENBQXlDO0lBSWhFLE9BQU8sQ0FBQyx3QkFBd0IsQ0FBeUM7SUFPekUsWUFDVSxTQUFTLEVBQUUsU0FBUyxFQUNwQixhQUFhLEVBQUUsYUFBYSxFQUM1QixTQUFTLEVBQUUsU0FBUyxFQUNwQixHQUFHLEVBQUUsTUFBTSxFQUNqQjtJQUVKOzs7Ozs7OztPQVFHO0lBQ0csb0JBQW9CLENBQ3hCLGVBQWUsRUFBRSxZQUFZLEVBQzdCLHlCQUF5QixFQUFFLGdCQUFnQixHQUFHLElBQUksRUFDbEQsZUFBZSxFQUFFLENBQUMsSUFBSSxFQUFFLFlBQVksRUFBRSxNQUFNLEVBQUUsWUFBWSxFQUFFLEtBQUssT0FBTyxDQUFDLEdBQUcsQ0FBQyxFQUM3RSxpQkFBaUIsRUFBRSxXQUFXLEVBQzlCLEtBQUssRUFBRSxNQUFNLEVBQ2IsTUFBTSxFQUFFLFlBQVksRUFBRSxHQUNyQixPQUFPLENBQUMsSUFBSSxDQUFDLENBTWY7SUFFRCxvRUFBb0U7SUFDcEUsMkJBQTJCLENBQUMsZUFBZSxFQUFFLFlBQVksRUFBRSxNQUFNLEVBQUUsWUFBWSxFQUFFLEdBQUcsSUFBSSxDQUt2RjtJQUVELGdGQUFnRjtJQUNoRixJQUFJLElBQUksSUFBSSxDQUlYO0lBRUQsTUFBTSxDQUFDLE1BQU0sRUFBRSxNQUFNLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUVwQztJQUVELGFBQWEsQ0FBQyxNQUFNLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FNM0M7Q0F3RkYifQ==

package/dest/contract_sync/contract_sync_service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract_sync_service.d.ts","sourceRoot":"","sources":["../../src/contract_sync/contract_sync_service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAGpD,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AAEzE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6CAA6C,CAAC;AACjF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAMrE;;;;;GAKG;AACH,qBAAa,mBAAoB,YAAW,WAAW;;IAkBnD,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,GAAG;IApBb,QAAQ,CAAC,SAAS,mBAAmB;IAKrC,OAAO,CAAC,eAAe,CAAyC;IAIhE,OAAO,CAAC,wBAAwB,CAAyC;IAOzE,YACU,SAAS,EAAE,SAAS,EACpB,aAAa,EAAE,aAAa,EAC5B,SAAS,EAAE,SAAS,EACpB,GAAG,EAAE,MAAM,EACjB;IAEJ;;;;;;;;OAQG;IACG,oBAAoB,CACxB,eAAe,EAAE,YAAY,EAC7B,yBAAyB,EAAE,gBAAgB,GAAG,IAAI,EAClD,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,EAC7E,iBAAiB,EAAE,WAAW,EAC9B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,YAAY,EAAE,GACrB,OAAO,CAAC,IAAI,CAAC,CAMf;IAED,oEAAoE;IACpE,2BAA2B,CAAC,eAAe,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAKvF;IAED,gFAAgF;IAChF,IAAI,IAAI,IAAI,CAIX;IAED,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEpC;IAED,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAM3C;CAwFF"}

package/dest/contract_sync/contract_sync_service.js

@@ -0,0 +1,135 @@
+import { Semaphore } from '@aztec/foundation/queue';
+import { isProtocolContract } from '@aztec/protocol-contracts';
+import { NoteService } from '../notes/note_service.js';
+import { syncScope, verifyCurrentClassId } from './helpers.js';
+/** Maximum number of scope syncs running concurrently across the PXE. */ const MAX_CONCURRENT_SCOPE_SYNCS = 5;
+/**
+ * Service for syncing the private state of contracts and verifying that the PXE holds the current class artifact.
+ * It uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
+ *
+ * TODO: The StagedStore naming is broken here. Figure out a better name.
+ */ export class ContractSyncService {
+    aztecNode;
+    contractStore;
+    noteStore;
+    log;
+    storeName;
+    // Tracks contracts synced since last wipe. The cache is keyed per individual scope address
+    // (`contractAddress:scopeAddress`), or `contractAddress:*` for all scopes (all accounts).
+    // The value is a promise that resolves when the contract is synced.
+    syncedContracts;
+    // Tracks class ID verification per contract. Keyed by contract address only (no scope), since
+    // class ID verification is scope-independent. Cleared on wipe/discard.
+    classIdVerificationCache;
+    // Bounds the number of scope syncs running concurrently. Scopes beyond this limit queue here. Sized to trade off
+    // parallelism on non-ACIR work (node RPC, note store reads) against memory pressure from concurrent circuit
+    // execution.
+    #syncSlot;
+    constructor(aztecNode, contractStore, noteStore, log){
+        this.aztecNode = aztecNode;
+        this.contractStore = contractStore;
+        this.noteStore = noteStore;
+        this.log = log;
+        this.storeName = 'contract_sync';
+        this.syncedContracts = new Map();
+        this.classIdVerificationCache = new Map();
+        this.#syncSlot = new Semaphore(MAX_CONCURRENT_SCOPE_SYNCS);
+    }
+    /**
+   * Ensures a contract's private state is synchronized and that the PXE holds the current class artifact.
+   * Uses a cache to avoid redundant sync operations - the cache is wiped when the anchor block changes.
+   * @param contractAddress - The address of the contract to sync.
+   * @param functionToInvokeAfterSync - The function selector that will be called after sync (used to validate it's
+   * not sync_state itself).
+   * @param utilityExecutor - Executor function for running the sync_state utility function.
+   * @param scopes - Access scopes to pass through to the utility executor (affects whose account's private state is discovered).
+   */ async ensureContractSynced(contractAddress, functionToInvokeAfterSync, utilityExecutor, anchorBlockHeader, jobId, scopes) {
+        this.#startSyncIfNeeded(contractAddress, scopes, anchorBlockHeader, jobId, (scope)=>syncScope(contractAddress, this.contractStore, functionToInvokeAfterSync, utilityExecutor, scope));
+        await this.#awaitSync(contractAddress, scopes);
+    }
+    /** Clears sync cache entries for the given scopes of a contract. */ invalidateContractForScopes(contractAddress, scopes) {
+        if (scopes.length === 0) {
+            return;
+        }
+        scopes.forEach((scope)=>this.syncedContracts.delete(toKey(contractAddress, scope)));
+    }
+    /** Clears sync cache. Called by BlockSynchronizer when anchor block changes. */ wipe() {
+        this.log.debug(`Wiping contract sync cache (${this.syncedContracts.size} entries)`);
+        this.syncedContracts.clear();
+        this.classIdVerificationCache.clear();
+    }
+    commit(_jobId) {
+        return Promise.resolve();
+    }
+    discardStaged(_jobId) {
+        // We clear the synced contracts cache here because, when the job is discarded, any associated database writes from
+        // the sync are also undone.
+        this.syncedContracts.clear();
+        this.classIdVerificationCache.clear();
+        return Promise.resolve();
+    }
+    /**
+   * For each unsynced scope, creates a promise that waits on:
+   *  1. Class ID verification (cached per contract, scope-independent).
+   *  2. Note nullifier sync (shared, batched across all unsynced scopes).
+   *  3. Per-scope sync (individual, semaphore-bounded).
+   */ #startSyncIfNeeded(contractAddress, scopes, anchorBlockHeader, jobId, syncScopeFn) {
+        const scopesToSync = scopes.filter((scope)=>!this.syncedContracts.has(toKey(contractAddress, scope)));
+        if (scopesToSync.length === 0) {
+            return;
+        }
+        this.log.debug(`Syncing contract ${contractAddress} for ${scopesToSync.length} scope(s)`);
+        const verifyPromise = this.#verifyClassId(contractAddress, anchorBlockHeader);
+        const syncNullifiersPromise = this.#syncNoteNullifiers(contractAddress, anchorBlockHeader, jobId, scopesToSync);
+        for (const scope of scopesToSync){
+            const key = toKey(contractAddress, scope);
+            const promise = Promise.all([
+                verifyPromise,
+                syncNullifiersPromise,
+                this.#runBounded(()=>syncScopeFn(scope))
+            ]).then(()=>{}).catch((err)=>{
+                this.syncedContracts.delete(key);
+                throw err;
+            });
+            this.syncedContracts.set(key, promise);
+        }
+    }
+    /** Verifies the local class ID matches the on-chain value (cached, evicts on failure so retries re-verify). */ #verifyClassId(contractAddress, anchorBlockHeader) {
+        const contractKey = contractAddress.toString();
+        const cached = this.classIdVerificationCache.get(contractKey);
+        if (cached) {
+            return cached;
+        }
+        const promise = verifyCurrentClassId(contractAddress, this.aztecNode, this.contractStore, anchorBlockHeader).catch((err)=>{
+            this.classIdVerificationCache.delete(contractKey);
+            throw err;
+        });
+        this.classIdVerificationCache.set(contractKey, promise);
+        return promise;
+    }
+    /** Syncs note nullifiers across all unsynced scopes in a single batched call. */ async #syncNoteNullifiers(contractAddress, anchorBlockHeader, jobId, scopes) {
+        // Protocol contracts don't have private state to sync
+        if (isProtocolContract(contractAddress)) {
+            return;
+        }
+        // This runs in parallel with per-scope sync (which also writes to the note store). That's safe because
+        // the note store handles concurrent operations.
+        const noteService = new NoteService(this.noteStore, this.aztecNode, anchorBlockHeader, jobId);
+        await noteService.syncNoteNullifiers(contractAddress, scopes);
+    }
+    /** Runs fn while holding a slot in #syncSlot, bounding total concurrent scope syncs. */ async #runBounded(fn) {
+        await this.#syncSlot.acquire();
+        try {
+            return await fn();
+        } finally{
+            this.#syncSlot.release();
+        }
+    }
+    /** Collects all relevant scope promises (including in-flight ones from concurrent calls) and awaits them. */ async #awaitSync(contractAddress, scopes) {
+        const promises = scopes.map((scope)=>this.syncedContracts.get(toKey(contractAddress, scope))).filter((p)=>p !== undefined);
+        await Promise.all(promises);
+    }
+}
+function toKey(contract, scope) {
+    return `${contract.toString()}:${scope.toString()}`;
+}

package/dest/contract_sync/helpers.d.ts

@@ -0,0 +1,27 @@
+import type { FunctionCall, FunctionSelector } from '@aztec/stdlib/abi';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { ContractInstance } from '@aztec/stdlib/contract';
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+import type { BlockHeader } from '@aztec/stdlib/tx';
+import type { ContractStore } from '../storage/contract_store/contract_store.js';
+/**
+ * Read the current class id of a contract from the execution data provider or AztecNode. If not found, class id
+ * from the instance is used.
+ * @param contractAddress - The address of the contract to read the class id for.
+ * @param instance - The instance of the contract.
+ * @param aztecNode - The Aztec node to query for storage.
+ * @param header - The header of the block at which to load the DelayedPublicMutable storing the class id.
+ * @returns The current class id.
+ */
+export declare function readCurrentClassId(contractAddress: AztecAddress, instance: ContractInstance, aztecNode: AztecNode, header: BlockHeader): Promise<import("@aztec/foundation/schemas").Fr>;
+export declare function syncScope(contractAddress: AztecAddress, contractStore: ContractStore, functionToInvokeAfterSync: FunctionSelector | null, utilityExecutor: (privateSyncCall: FunctionCall, scopes: AztecAddress[]) => Promise<any>, scope: AztecAddress): Promise<void>;
+/**
+ * Verify that the current class id of a contract obtained from AztecNode is the same as the one in contract data
+ * provider (i.e. PXE's own storage).
+ * @param contractAddress - The address of the contract to verify.
+ * @param aztecNode - The Aztec node to query for storage.
+ * @param contractStore - The contract store to fetch the local instance from.
+ * @param header - The header of the block at which to verify the current class id.
+ */
+export declare function verifyCurrentClassId(contractAddress: AztecAddress, aztecNode: AztecNode, contractStore: ContractStore, header: BlockHeader): Promise<void>;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVycy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnRyYWN0X3N5bmMvaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQztBQUN4RSxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUNoRSxPQUFPLEtBQUssRUFBRSxnQkFBZ0IsRUFBRSxNQUFNLHdCQUF3QixDQUFDO0FBRS9ELE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLGlDQUFpQyxDQUFDO0FBQ2pFLE9BQU8sS0FBSyxFQUFFLFdBQVcsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBRXBELE9BQU8sS0FBSyxFQUFFLGFBQWEsRUFBRSxNQUFNLDZDQUE2QyxDQUFDO0FBRWpGOzs7Ozs7OztHQVFHO0FBQ0gsd0JBQXNCLGtCQUFrQixDQUN0QyxlQUFlLEVBQUUsWUFBWSxFQUM3QixRQUFRLEVBQUUsZ0JBQWdCLEVBQzFCLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLE1BQU0sRUFBRSxXQUFXLG1EQWFwQjtBQUVELHdCQUFzQixTQUFTLENBQzdCLGVBQWUsRUFBRSxZQUFZLEVBQzdCLGFBQWEsRUFBRSxhQUFhLEVBQzVCLHlCQUF5QixFQUFFLGdCQUFnQixHQUFHLElBQUksRUFDbEQsZUFBZSxFQUFFLENBQUMsZUFBZSxFQUFFLFlBQVksRUFBRSxNQUFNLEVBQUUsWUFBWSxFQUFFLEtBQUssT0FBTyxDQUFDLEdBQUcsQ0FBQyxFQUN4RixLQUFLLEVBQUUsWUFBWSxpQkFlcEI7QUFFRDs7Ozs7OztHQU9HO0FBQ0gsd0JBQXNCLG9CQUFvQixDQUN4QyxlQUFlLEVBQUUsWUFBWSxFQUM3QixTQUFTLEVBQUUsU0FBUyxFQUNwQixhQUFhLEVBQUUsYUFBYSxFQUM1QixNQUFNLEVBQUUsV0FBVyxpQkFhcEIifQ==

package/dest/contract_sync/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/contract_sync/helpers.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE/D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6CAA6C,CAAC;AAEjF;;;;;;;;GAQG;AACH,wBAAsB,kBAAkB,CACtC,eAAe,EAAE,YAAY,EAC7B,QAAQ,EAAE,gBAAgB,EAC1B,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,WAAW,mDAapB;AAED,wBAAsB,SAAS,CAC7B,eAAe,EAAE,YAAY,EAC7B,aAAa,EAAE,aAAa,EAC5B,yBAAyB,EAAE,gBAAgB,GAAG,IAAI,EAClD,eAAe,EAAE,CAAC,eAAe,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,EACxF,KAAK,EAAE,YAAY,iBAepB;AAED;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CACxC,eAAe,EAAE,YAAY,EAC7B,SAAS,EAAE,SAAS,EACpB,aAAa,EAAE,aAAa,EAC5B,MAAM,EAAE,WAAW,iBAapB"}

package/dest/contract_sync/helpers.js

@@ -0,0 +1,53 @@
+import { ProtocolContractAddress, isProtocolContract } from '@aztec/protocol-contracts';
+import { DelayedPublicMutableValues, DelayedPublicMutableValuesWithHash } from '@aztec/stdlib/delayed-public-mutable';
+/**
+ * Read the current class id of a contract from the execution data provider or AztecNode. If not found, class id
+ * from the instance is used.
+ * @param contractAddress - The address of the contract to read the class id for.
+ * @param instance - The instance of the contract.
+ * @param aztecNode - The Aztec node to query for storage.
+ * @param header - The header of the block at which to load the DelayedPublicMutable storing the class id.
+ * @returns The current class id.
+ */ export async function readCurrentClassId(contractAddress, instance, aztecNode, header) {
+    const blockHash = await header.hash();
+    const timestamp = header.globalVariables.timestamp;
+    const { delayedPublicMutableSlot } = await DelayedPublicMutableValuesWithHash.getContractUpdateSlots(contractAddress);
+    const delayedPublicMutableValues = await DelayedPublicMutableValues.readFromTree(delayedPublicMutableSlot, (slot)=>aztecNode.getPublicStorageAt(blockHash, ProtocolContractAddress.ContractInstanceRegistry, slot));
+    let currentClassId = delayedPublicMutableValues.svc.getCurrentAt(timestamp)[0];
+    if (currentClassId.isZero()) {
+        currentClassId = instance.originalContractClassId;
+    }
+    return currentClassId;
+}
+export async function syncScope(contractAddress, contractStore, functionToInvokeAfterSync, utilityExecutor, scope) {
+    // Protocol contracts don't have private state to sync
+    if (isProtocolContract(contractAddress)) {
+        return;
+    }
+    const syncStateFunctionCall = await contractStore.getFunctionCall('sync_state', [
+        scope
+    ], contractAddress);
+    if (functionToInvokeAfterSync && functionToInvokeAfterSync.equals(syncStateFunctionCall.selector)) {
+        throw new Error('Forbidden `sync_state` invocation. `sync_state` can only be invoked by PXE, manual execution can lead to inconsistencies.');
+    }
+    await utilityExecutor(syncStateFunctionCall, [
+        scope
+    ]);
+}
+/**
+ * Verify that the current class id of a contract obtained from AztecNode is the same as the one in contract data
+ * provider (i.e. PXE's own storage).
+ * @param contractAddress - The address of the contract to verify.
+ * @param aztecNode - The Aztec node to query for storage.
+ * @param contractStore - The contract store to fetch the local instance from.
+ * @param header - The header of the block at which to verify the current class id.
+ */ export async function verifyCurrentClassId(contractAddress, aztecNode, contractStore, header) {
+    const instance = await contractStore.getContractInstance(contractAddress);
+    if (!instance) {
+        throw new Error(`No contract instance found for address ${contractAddress.toString()}`);
+    }
+    const currentClassId = await readCurrentClassId(contractAddress, instance, aztecNode, header);
+    if (!instance.currentContractClassId.equals(currentClassId)) {
+        throw new Error(`Contract ${contractAddress} is outdated, current class id is ${currentClassId}, local class id is ${instance.currentContractClassId}`);
+    }
+}

package/dest/debug/pxe_debug_utils.d.ts

@@ -0,0 +1,40 @@
+import type { FunctionCall } from '@aztec/stdlib/abi';
+import type { AuthWitness } from '@aztec/stdlib/auth-witness';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { NoteDao } from '@aztec/stdlib/note';
+import type { ContractOverrides } from '@aztec/stdlib/tx';
+import type { BlockSynchronizer } from '../block_synchronizer/block_synchronizer.js';
+import type { ContractFunctionSimulator } from '../contract_function_simulator/contract_function_simulator.js';
+import type { ContractSyncService } from '../contract_sync/contract_sync_service.js';
+import type { NotesFilter } from '../notes_filter.js';
+import type { AnchorBlockStore } from '../storage/index.js';
+import type { NoteStore } from '../storage/note_store/note_store.js';
+/**
+ * Methods provided by this class might help debugging but must not be used in production.
+ * No backwards compatibility or API stability should be expected. Use at your own risk.
+ */
+export declare class PXEDebugUtils {
+    #private;
+    private contractSyncService;
+    private noteStore;
+    private blockStateSynchronizer;
+    private anchorBlockStore;
+    constructor(contractSyncService: ContractSyncService, noteStore: NoteStore, blockStateSynchronizer: BlockSynchronizer, anchorBlockStore: AnchorBlockStore);
+    /** Not injected through constructor since they're are co-dependant */
+    setPXEHelpers(putJobInQueue: <T>(job: (jobId: string) => Promise<T>) => Promise<T>, getSimulatorForTx: (overrides?: {
+        contracts?: ContractOverrides;
+    }) => ContractFunctionSimulator, executeUtility: (contractFunctionSimulator: ContractFunctionSimulator, call: FunctionCall, authWitnesses: AuthWitness[] | undefined, scopes: AztecAddress[], jobId: string) => Promise<any>): void;
+    /**
+     * A debugging utility to get notes based on the provided filter.
+     *
+     * Note that this should not be used in production code because the structure of notes is considered to be
+     * an implementation detail of contracts. This is only meant to be used for debugging purposes. If you need to obtain
+     * note-related information in production code, please implement a custom utility function on your contract and call
+     * that function instead (e.g. `get_balance(owner: AztecAddress) -> u128` utility function on a Token contract).
+     *
+     * @param filter - The filter to apply to the notes.
+     * @returns The requested notes.
+     */
+    getNotes(filter: NotesFilter): Promise<NoteDao[]>;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHhlX2RlYnVnX3V0aWxzLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZGVidWcvcHhlX2RlYnVnX3V0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxFQUFFLFlBQVksRUFBRSxNQUFNLG1CQUFtQixDQUFDO0FBQ3RELE9BQU8sS0FBSyxFQUFFLFdBQVcsRUFBRSxNQUFNLDRCQUE0QixDQUFDO0FBQzlELE9BQU8sS0FBSyxFQUFFLFlBQVksRUFBRSxNQUFNLDZCQUE2QixDQUFDO0FBQ2hFLE9BQU8sS0FBSyxFQUFFLE9BQU8sRUFBRSxNQUFNLG9CQUFvQixDQUFDO0FBQ2xELE9BQU8sS0FBSyxFQUFFLGlCQUFpQixFQUFFLE1BQU0sa0JBQWtCLENBQUM7QUFFMUQsT0FBTyxLQUFLLEVBQUUsaUJBQWlCLEVBQUUsTUFBTSw2Q0FBNkMsQ0FBQztBQUNyRixPQUFPLEtBQUssRUFBRSx5QkFBeUIsRUFBRSxNQUFNLCtEQUErRCxDQUFDO0FBQy9HLE9BQU8sS0FBSyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sMkNBQTJDLENBQUM7QUFDckYsT0FBTyxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0sb0JBQW9CLENBQUM7QUFDdEQsT0FBTyxLQUFLLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUM1RCxPQUFPLEtBQUssRUFBRSxTQUFTLEVBQUUsTUFBTSxxQ0FBcUMsQ0FBQztBQUVyRTs7O0dBR0c7QUFDSCxxQkFBYSxhQUFhOztJQVl0QixPQUFPLENBQUMsbUJBQW1CO0lBQzNCLE9BQU8sQ0FBQyxTQUFTO0lBQ2pCLE9BQU8sQ0FBQyxzQkFBc0I7SUFDOUIsT0FBTyxDQUFDLGdCQUFnQjtJQUoxQixZQUNVLG1CQUFtQixFQUFFLG1CQUFtQixFQUN4QyxTQUFTLEVBQUUsU0FBUyxFQUNwQixzQkFBc0IsRUFBRSxpQkFBaUIsRUFDekMsZ0JBQWdCLEVBQUUsZ0JBQWdCLEVBQ3hDO0lBRUosc0VBQXNFO0lBQy9ELGFBQWEsQ0FDbEIsYUFBYSxFQUFFLENBQUMsQ0FBQyxFQUFFLEdBQUcsRUFBRSxDQUFDLEtBQUssRUFBRSxNQUFNLEtBQUssT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLE9BQU8sQ0FBQyxDQUFDLENBQUMsRUFDcEUsaUJBQWlCLEVBQUUsQ0FBQyxTQUFTLENBQUMsRUFBRTtRQUFFLFNBQVMsQ0FBQyxFQUFFLGlCQUFpQixDQUFBO0tBQUUsS0FBSyx5QkFBeUIsRUFDL0YsY0FBYyxFQUFFLENBQ2QseUJBQXlCLEVBQUUseUJBQXlCLEVBQ3BELElBQUksRUFBRSxZQUFZLEVBQ2xCLGFBQWEsRUFBRSxXQUFXLEVBQUUsR0FBRyxTQUFTLEVBQ3hDLE1BQU0sRUFBRSxZQUFZLEVBQUUsRUFDdEIsS0FBSyxFQUFFLE1BQU0sS0FDVixPQUFPLENBQUMsR0FBRyxDQUFDLFFBS2xCO0lBRUQ7Ozs7Ozs7Ozs7T0FVRztJQUNJLFFBQVEsQ0FBQyxNQUFNLEVBQUUsV0FBVyxHQUFHLE9BQU8sQ0FBQyxPQUFPLEVBQUUsQ0FBQyxDQW9CdkQ7Q0FDRiJ9

package/dest/debug/pxe_debug_utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pxe_debug_utils.d.ts","sourceRoot":"","sources":["../../src/debug/pxe_debug_utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAE1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AACrF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,+DAA+D,CAAC;AAC/G,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2CAA2C,CAAC;AACrF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAErE;;;GAGG;AACH,qBAAa,aAAa;;IAYtB,OAAO,CAAC,mBAAmB;IAC3B,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,sBAAsB;IAC9B,OAAO,CAAC,gBAAgB;IAJ1B,YACU,mBAAmB,EAAE,mBAAmB,EACxC,SAAS,EAAE,SAAS,EACpB,sBAAsB,EAAE,iBAAiB,EACzC,gBAAgB,EAAE,gBAAgB,EACxC;IAEJ,sEAAsE;IAC/D,aAAa,CAClB,aAAa,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EACpE,iBAAiB,EAAE,CAAC,SAAS,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,iBAAiB,CAAA;KAAE,KAAK,yBAAyB,EAC/F,cAAc,EAAE,CACd,yBAAyB,EAAE,yBAAyB,EACpD,IAAI,EAAE,YAAY,EAClB,aAAa,EAAE,WAAW,EAAE,GAAG,SAAS,EACxC,MAAM,EAAE,YAAY,EAAE,EACtB,KAAK,EAAE,MAAM,KACV,OAAO,CAAC,GAAG,CAAC,QAKlB;IAED;;;;;;;;;;OAUG;IACI,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAoBvD;CACF"}