@aztec/pxe 0.0.1-commit.d3ec352c → 0.0.1-commit.e61ad554

package/dest/tagging/recipient_sync/utils/load_logs_for_range.js

@@ -0,0 +1,32 @@
+import { SiloedTag, Tag } from '@aztec/stdlib/logs';
+import { getAllPrivateLogsByTags } from '../../get_all_logs_by_tags.js';
+/**
+ * Gets private logs with their corresponding block timestamps and tagging indexes for the given index range, `app` and
+ * `secret`. At most load logs from blocks up to and including `anchorBlockNumber`. `start` is inclusive and `end` is
+ * exclusive.
+ */ export async function loadLogsForRange(secret, app, aztecNode, start, end, anchorBlockNumber, anchorBlockHash) {
+    // Derive tags for the window
+    const preTags = Array(end - start).fill(0).map((_, i)=>({
+            secret,
+            index: start + i
+        }));
+    const siloedTags = await Promise.all(preTags.map((preTag)=>Tag.compute(preTag))).then((tags)=>Promise.all(tags.map((tag)=>SiloedTag.compute(tag, app))));
+    // We use the utility function below to retrieve all logs for the tags across all pages, so we don't need to handle
+    // pagination here.
+    const logs = await getAllPrivateLogsByTags(aztecNode, siloedTags, anchorBlockHash);
+    // Pair logs with their corresponding tagging indexes
+    const logsWithIndexes = [];
+    for(let i = 0; i < logs.length; i++){
+        const logsForTag = logs[i];
+        const taggingIndex = preTags[i].index;
+        for (const log of logsForTag){
+            if (log.blockNumber <= anchorBlockNumber) {
+                logsWithIndexes.push({
+                    log,
+                    taggingIndex
+                });
+            }
+        }
+    }
+    return logsWithIndexes;
+}

package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts

@@ -0,0 +1,21 @@
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { L2BlockHash } from '@aztec/stdlib/block';
+import type { AztecNode } from '@aztec/stdlib/interfaces/server';
+import type { DirectionalAppTaggingSecret } from '@aztec/stdlib/logs';
+import type { SenderTaggingStore } from '../../storage/tagging_store/sender_tagging_store.js';
+/**
+ * Syncs tagging indexes. This function needs to be called whenever a private log is being sent.
+ *
+ * @param secret - The secret that's unique for (sender, recipient, contract) tuple while the direction of
+ * sender -> recipient matters.
+ * @param app - The address of the contract that the logs are tagged for. Needs to be provided because we perform
+ * second round of siloing in this function which is necessary because kernels do it as well (they silo first field
+ * of the private log which corresponds to the tag).
+ * @remarks When syncing the indexes as sender we don't care about the log contents - we only care about the highest
+ * pending and highest finalized indexes as that guides the next index choice when sending a log. The next index choice
+ * is simply the highest pending index plus one (or finalized if pending is undefined).
+ * @dev This function looks for new indexes, adds them to pending, then it checks status of each pending index and
+ * updates its status accordingly.
+ */
+export declare function syncSenderTaggingIndexes(secret: DirectionalAppTaggingSecret, app: AztecAddress, aztecNode: AztecNode, taggingStore: SenderTaggingStore, anchorBlockHash: L2BlockHash, jobId: string): Promise<void>;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3luY19zZW5kZXJfdGFnZ2luZ19pbmRleGVzLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdGFnZ2luZy9zZW5kZXJfc3luYy9zeW5jX3NlbmRlcl90YWdnaW5nX2luZGV4ZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsWUFBWSxFQUFFLE1BQU0sNkJBQTZCLENBQUM7QUFDaEUsT0FBTyxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFDdkQsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0saUNBQWlDLENBQUM7QUFDakUsT0FBTyxLQUFLLEVBQUUsMkJBQTJCLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUV0RSxPQUFPLEtBQUssRUFBRSxrQkFBa0IsRUFBRSxNQUFNLHFEQUFxRCxDQUFDO0FBSzlGOzs7Ozs7Ozs7Ozs7O0dBYUc7QUFDSCx3QkFBc0Isd0JBQXdCLENBQzVDLE1BQU0sRUFBRSwyQkFBMkIsRUFDbkMsR0FBRyxFQUFFLFlBQVksRUFDakIsU0FBUyxFQUFFLFNBQVMsRUFDcEIsWUFBWSxFQUFFLGtCQUFrQixFQUNoQyxlQUFlLEVBQUUsV0FBVyxFQUM1QixLQUFLLEVBQUUsTUFBTSxHQUNaLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FtRWYifQ==

package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync_sender_tagging_indexes.d.ts","sourceRoot":"","sources":["../../../src/tagging/sender_sync/sync_sender_tagging_indexes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AAEtE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qDAAqD,CAAC;AAK9F;;;;;;;;;;;;;GAaG;AACH,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,2BAA2B,EACnC,GAAG,EAAE,YAAY,EACjB,SAAS,EAAE,SAAS,EACpB,YAAY,EAAE,kBAAkB,EAChC,eAAe,EAAE,WAAW,EAC5B,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,IAAI,CAAC,CAmEf"}

package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js

@@ -0,0 +1,74 @@
+import { UNFINALIZED_TAGGING_INDEXES_WINDOW_LEN } from '../constants.js';
+import { getStatusChangeOfPending } from './utils/get_status_change_of_pending.js';
+import { loadAndStoreNewTaggingIndexes } from './utils/load_and_store_new_tagging_indexes.js';
+/**
+ * Syncs tagging indexes. This function needs to be called whenever a private log is being sent.
+ *
+ * @param secret - The secret that's unique for (sender, recipient, contract) tuple while the direction of
+ * sender -> recipient matters.
+ * @param app - The address of the contract that the logs are tagged for. Needs to be provided because we perform
+ * second round of siloing in this function which is necessary because kernels do it as well (they silo first field
+ * of the private log which corresponds to the tag).
+ * @remarks When syncing the indexes as sender we don't care about the log contents - we only care about the highest
+ * pending and highest finalized indexes as that guides the next index choice when sending a log. The next index choice
+ * is simply the highest pending index plus one (or finalized if pending is undefined).
+ * @dev This function looks for new indexes, adds them to pending, then it checks status of each pending index and
+ * updates its status accordingly.
+ */ export async function syncSenderTaggingIndexes(secret, app, aztecNode, taggingStore, anchorBlockHash, jobId) {
+    // # Explanation of how syncing works
+    //
+    // When choosing an index, we select: highest pending index + 1 (or highest finalized index + 1 if no pending).
+    // If the chosen index is more than WINDOW_LEN from the highest finalized index, we throw an error. By having this
+    // hard limit we give a guarantee to a recipient that he doesn't need to look further than WINDOW_LEN ahead of the
+    // highest finalized index.
+    //
+    // This function synchronizes the finalized and pending indexes by iteratively querying the node for a window of
+    // indexes at a time, storing all those indexes as pending, and then checking the status of each pending index to
+    // update its finalization status accordingly. If we stumble upon a window with no indexes, we stop the loop.
+    //
+    // Stopping at that point is safe because of the limit described above - there can never be an index that is more
+    // than WINDOW_LEN from the highest finalized index.
+    //
+    // # Note on performance
+    // Each window advance requires two queries (logs + tx status). For example, syncing indexes 0–500 with a window of
+    // 100 takes at least 10 round trips (5 windows × 2 queries).
+    const finalizedIndex = await taggingStore.getLastFinalizedIndex(secret, jobId);
+    let start = finalizedIndex === undefined ? 0 : finalizedIndex + 1;
+    let end = start + UNFINALIZED_TAGGING_INDEXES_WINDOW_LEN;
+    let previousFinalizedIndex = finalizedIndex;
+    let newFinalizedIndex = undefined;
+    while(true){
+        // Load and store indexes for the current window. These indexes may already exist in the database if txs using
+        // them were previously sent from this PXE. Any duplicates are handled by the tagging data provider.
+        await loadAndStoreNewTaggingIndexes(secret, app, start, end, aztecNode, taggingStore, anchorBlockHash, jobId);
+        // Retrieve all indexes within the current window from storage and update their status accordingly.
+        const pendingTxHashes = await taggingStore.getTxHashesOfPendingIndexes(secret, start, end, jobId);
+        if (pendingTxHashes.length === 0) {
+            break;
+        }
+        const { txHashesToFinalize, txHashesToDrop } = await getStatusChangeOfPending(pendingTxHashes, aztecNode);
+        await taggingStore.dropPendingIndexes(txHashesToDrop, jobId);
+        await taggingStore.finalizePendingIndexes(txHashesToFinalize, jobId);
+        // We check if the finalized index has been updated.
+        newFinalizedIndex = await taggingStore.getLastFinalizedIndex(secret, jobId);
+        if (previousFinalizedIndex !== newFinalizedIndex) {
+            // A new finalized index was found, so we'll run the loop again. For example:
+            // - Previous finalized index: 10
+            // - New finalized index: 13
+            // - Window length: 10
+            //
+            // In the last iteration, we processed indexes 11-20. To avoid reprocessing the same logs,
+            // we'll only look at the new indexes 21-23:
+            //
+            //    Previous window: [11, 12, 13, 14, 15, 16, 17, 18, 19, 20]
+            //    New window:                                             [21, 22, 23]
+            const previousEnd = end;
+            // Add 1 because `end` is exclusive and the known finalized index is not included in the window.
+            end = newFinalizedIndex + UNFINALIZED_TAGGING_INDEXES_WINDOW_LEN + 1;
+            start = previousEnd;
+            previousFinalizedIndex = newFinalizedIndex;
+        } else {
+            break;
+        }
+    }
+}

package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts

@@ -0,0 +1,11 @@
+import type { AztecNode } from '@aztec/stdlib/interfaces/server';
+import { TxHash } from '@aztec/stdlib/tx';
+/**
+ * Based on receipts obtained from `aztecNode` returns which pending transactions changed their status to finalized or
+ * dropped.
+ */
+export declare function getStatusChangeOfPending(pending: TxHash[], aztecNode: AztecNode): Promise<{
+    txHashesToFinalize: TxHash[];
+    txHashesToDrop: TxHash[];
+}>;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2V0X3N0YXR1c19jaGFuZ2Vfb2ZfcGVuZGluZy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL3RhZ2dpbmcvc2VuZGVyX3N5bmMvdXRpbHMvZ2V0X3N0YXR1c19jaGFuZ2Vfb2ZfcGVuZGluZy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssRUFBRSxTQUFTLEVBQUUsTUFBTSxpQ0FBaUMsQ0FBQztBQUNqRSxPQUFPLEVBQUUsTUFBTSxFQUFZLE1BQU0sa0JBQWtCLENBQUM7QUFFcEQ7OztHQUdHO0FBQ0gsd0JBQXNCLHdCQUF3QixDQUM1QyxPQUFPLEVBQUUsTUFBTSxFQUFFLEVBQ2pCLFNBQVMsRUFBRSxTQUFTLEdBQ25CLE9BQU8sQ0FBQztJQUFFLGtCQUFrQixFQUFFLE1BQU0sRUFBRSxDQUFDO0lBQUMsY0FBYyxFQUFFLE1BQU0sRUFBRSxDQUFBO0NBQUUsQ0FBQyxDQXlCckUifQ==

package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get_status_change_of_pending.d.ts","sourceRoot":"","sources":["../../../../src/tagging/sender_sync/utils/get_status_change_of_pending.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,MAAM,EAAY,MAAM,kBAAkB,CAAC;AAEpD;;;GAGG;AACH,wBAAsB,wBAAwB,CAC5C,OAAO,EAAE,MAAM,EAAE,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAAC;IAAE,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAAC,cAAc,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC,CAyBrE"}

package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js

@@ -0,0 +1,29 @@
+import { TxStatus } from '@aztec/stdlib/tx';
+/**
+ * Based on receipts obtained from `aztecNode` returns which pending transactions changed their status to finalized or
+ * dropped.
+ */ export async function getStatusChangeOfPending(pending, aztecNode) {
+    // Get receipts for all pending tx hashes.
+    const receipts = await Promise.all(pending.map((pendingTxHash)=>aztecNode.getTxReceipt(pendingTxHash)));
+    const txHashesToFinalize = [];
+    const txHashesToDrop = [];
+    for(let i = 0; i < receipts.length; i++){
+        const receipt = receipts[i];
+        const txHash = pending[i];
+        if (receipt.status === TxStatus.FINALIZED && receipt.hasExecutionSucceeded()) {
+            // Tx has been included in a block and the corresponding block is finalized --> we mark the indexes as
+            // finalized.
+            txHashesToFinalize.push(txHash);
+        } else if (receipt.isDropped() || receipt.hasExecutionReverted()) {
+            // Tx was dropped or reverted --> we drop the corresponding pending indexes.
+            // TODO(#17615): Don't drop pending indexes corresponding to non-revertible phases.
+            txHashesToDrop.push(txHash);
+        } else {
+        // Tx is still pending, not yet finalized, or was mined successfully but not yet finalized --> we don't do anything.
+        }
+    }
+    return {
+        txHashesToFinalize,
+        txHashesToDrop
+    };
+}

package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts

@@ -0,0 +1,21 @@
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { L2BlockHash } from '@aztec/stdlib/block';
+import type { AztecNode } from '@aztec/stdlib/interfaces/server';
+import type { DirectionalAppTaggingSecret } from '@aztec/stdlib/logs';
+import type { SenderTaggingStore } from '../../../storage/tagging_store/sender_tagging_store.js';
+/**
+ * Loads tagging indexes from the Aztec node and stores them in the tagging data provider.
+ * @remarks This function is one of two places by which a pending index can get to the tagging data provider. The other
+ * place is when a tx is being sent from this PXE.
+ * @param secret - The directional app tagging secret that's unique for (sender, recipient, contract) tuple.
+ * @param app - The address of the contract that the logs are tagged for. Used for siloing tags to match
+ * kernel circuit behavior.
+ * @param start - The starting index (inclusive) of the window to process.
+ * @param end - The ending index (exclusive) of the window to process.
+ * @param aztecNode - The Aztec node instance to query for logs.
+ * @param taggingStore - The data provider to store pending indexes.
+ * @param jobId - Job identifier, used to keep writes in-memory until they can be persisted in a data integrity
+ * preserving way.
+ */
+export declare function loadAndStoreNewTaggingIndexes(secret: DirectionalAppTaggingSecret, app: AztecAddress, start: number, end: number, aztecNode: AztecNode, taggingStore: SenderTaggingStore, anchorBlockHash: L2BlockHash, jobId: string): Promise<void>;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9hZF9hbmRfc3RvcmVfbmV3X3RhZ2dpbmdfaW5kZXhlcy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL3RhZ2dpbmcvc2VuZGVyX3N5bmMvdXRpbHMvbG9hZF9hbmRfc3RvcmVfbmV3X3RhZ2dpbmdfaW5kZXhlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUNoRSxPQUFPLEtBQUssRUFBRSxXQUFXLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUN2RCxPQUFPLEtBQUssRUFBRSxTQUFTLEVBQUUsTUFBTSxpQ0FBaUMsQ0FBQztBQUNqRSxPQUFPLEtBQUssRUFBRSwyQkFBMkIsRUFBVSxNQUFNLG9CQUFvQixDQUFDO0FBSTlFLE9BQU8sS0FBSyxFQUFFLGtCQUFrQixFQUFFLE1BQU0sd0RBQXdELENBQUM7QUFHakc7Ozs7Ozs7Ozs7Ozs7R0FhRztBQUNILHdCQUFzQiw2QkFBNkIsQ0FDakQsTUFBTSxFQUFFLDJCQUEyQixFQUNuQyxHQUFHLEVBQUUsWUFBWSxFQUNqQixLQUFLLEVBQUUsTUFBTSxFQUNiLEdBQUcsRUFBRSxNQUFNLEVBQ1gsU0FBUyxFQUFFLFNBQVMsRUFDcEIsWUFBWSxFQUFFLGtCQUFrQixFQUNoQyxlQUFlLEVBQUUsV0FBVyxFQUM1QixLQUFLLEVBQUUsTUFBTSxpQkFrQmQifQ==

package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"load_and_store_new_tagging_indexes.d.ts","sourceRoot":"","sources":["../../../../src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,KAAK,EAAE,2BAA2B,EAAU,MAAM,oBAAoB,CAAC;AAI9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wDAAwD,CAAC;AAGjG;;;;;;;;;;;;;GAaG;AACH,wBAAsB,6BAA6B,CACjD,MAAM,EAAE,2BAA2B,EACnC,GAAG,EAAE,YAAY,EACjB,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,SAAS,EACpB,YAAY,EAAE,kBAAkB,EAChC,eAAe,EAAE,WAAW,EAC5B,KAAK,EAAE,MAAM,iBAkBd"}

package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js

@@ -0,0 +1,60 @@
+import { SiloedTag, Tag } from '@aztec/stdlib/logs';
+import { TxHash } from '@aztec/stdlib/tx';
+import { getAllPrivateLogsByTags } from '../../get_all_logs_by_tags.js';
+/**
+ * Loads tagging indexes from the Aztec node and stores them in the tagging data provider.
+ * @remarks This function is one of two places by which a pending index can get to the tagging data provider. The other
+ * place is when a tx is being sent from this PXE.
+ * @param secret - The directional app tagging secret that's unique for (sender, recipient, contract) tuple.
+ * @param app - The address of the contract that the logs are tagged for. Used for siloing tags to match
+ * kernel circuit behavior.
+ * @param start - The starting index (inclusive) of the window to process.
+ * @param end - The ending index (exclusive) of the window to process.
+ * @param aztecNode - The Aztec node instance to query for logs.
+ * @param taggingStore - The data provider to store pending indexes.
+ * @param jobId - Job identifier, used to keep writes in-memory until they can be persisted in a data integrity
+ * preserving way.
+ */ export async function loadAndStoreNewTaggingIndexes(secret, app, start, end, aztecNode, taggingStore, anchorBlockHash, jobId) {
+    // We compute the tags for the current window of indexes
+    const preTagsForWindow = Array(end - start).fill(0).map((_, i)=>({
+            secret,
+            index: start + i
+        }));
+    const siloedTagsForWindow = await Promise.all(preTagsForWindow.map(async (preTag)=>SiloedTag.compute(await Tag.compute(preTag), app)));
+    const txsForTags = await getTxsContainingTags(siloedTagsForWindow, aztecNode, anchorBlockHash);
+    const highestIndexMap = getTxHighestIndexMap(txsForTags, preTagsForWindow);
+    // Now we iterate over the map, reconstruct the preTags and tx hash and store them in the db.
+    for (const [txHashStr, highestIndex] of highestIndexMap.entries()){
+        const txHash = TxHash.fromString(txHashStr);
+        await taggingStore.storePendingIndexes([
+            {
+                secret,
+                index: highestIndex
+            }
+        ], txHash, jobId);
+    }
+}
+// Returns txs that used the given tags. A tag might have been used in multiple txs and for this reason we return
+// an array for each tag.
+async function getTxsContainingTags(tags, aztecNode, anchorBlockHash) {
+    // We use the utility function below to retrieve all logs for the tags across all pages, so we don't need to handle
+    // pagination here.
+    const allLogs = await getAllPrivateLogsByTags(aztecNode, tags, anchorBlockHash);
+    return allLogs.map((logs)=>logs.map((log)=>log.txHash));
+}
+// Returns a map of txHash to the highest index for that txHash.
+function getTxHighestIndexMap(txHashesForTags, preTagsForWindow) {
+    if (txHashesForTags.length !== preTagsForWindow.length) {
+        throw new Error(`Number of tx hashes arrays does not match number of pre-tags. ${txHashesForTags.length} !== ${preTagsForWindow.length}`);
+    }
+    const highestIndexMap = new Map();
+    for(let i = 0; i < txHashesForTags.length; i++){
+        const taggingIndex = preTagsForWindow[i].index;
+        const txHashesForTag = txHashesForTags[i];
+        for (const txHash of txHashesForTag){
+            const key = txHash.toString();
+            highestIndexMap.set(key, Math.max(highestIndexMap.get(key) ?? 0, taggingIndex));
+        }
+    }
+    return highestIndexMap;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aztec/pxe",
-  "version": "0.0.1-commit.d3ec352c",
+  "version": "0.0.1-commit.e61ad554",
   "type": "module",
   "exports": {
     "./server": "./dest/entrypoints/server/index.js",
@@ -11,7 +11,7 @@
   },
   "bin": "./dest/bin/index.js",
   "scripts": {
-    "build": "yarn clean && yarn generate && tsgo -b",
+    "build": "yarn clean && yarn generate && ../scripts/tsc.sh",
     "build:dev": "../scripts/tsc.sh --watch",
     "clean": "rm -rf ./dest .tsbuildinfo ./src/config/package_info.ts",
     "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ../node_modules/.bin/jest --passWithNoTests --maxWorkers=${JEST_MAX_WORKERS:-8}",
@@ -61,19 +61,19 @@
     ]
   },
   "dependencies": {
-    "@aztec/bb-prover": "0.0.1-commit.d3ec352c",
-    "@aztec/bb.js": "0.0.1-commit.d3ec352c",
-    "@aztec/builder": "0.0.1-commit.d3ec352c",
-    "@aztec/constants": "0.0.1-commit.d3ec352c",
-    "@aztec/ethereum": "0.0.1-commit.d3ec352c",
-    "@aztec/foundation": "0.0.1-commit.d3ec352c",
-    "@aztec/key-store": "0.0.1-commit.d3ec352c",
-    "@aztec/kv-store": "0.0.1-commit.d3ec352c",
-    "@aztec/noir-protocol-circuits-types": "0.0.1-commit.d3ec352c",
-    "@aztec/noir-types": "0.0.1-commit.d3ec352c",
-    "@aztec/protocol-contracts": "0.0.1-commit.d3ec352c",
-    "@aztec/simulator": "0.0.1-commit.d3ec352c",
-    "@aztec/stdlib": "0.0.1-commit.d3ec352c",
+    "@aztec/bb-prover": "0.0.1-commit.e61ad554",
+    "@aztec/bb.js": "0.0.1-commit.e61ad554",
+    "@aztec/builder": "0.0.1-commit.e61ad554",
+    "@aztec/constants": "0.0.1-commit.e61ad554",
+    "@aztec/ethereum": "0.0.1-commit.e61ad554",
+    "@aztec/foundation": "0.0.1-commit.e61ad554",
+    "@aztec/key-store": "0.0.1-commit.e61ad554",
+    "@aztec/kv-store": "0.0.1-commit.e61ad554",
+    "@aztec/noir-protocol-circuits-types": "0.0.1-commit.e61ad554",
+    "@aztec/noir-types": "0.0.1-commit.e61ad554",
+    "@aztec/protocol-contracts": "0.0.1-commit.e61ad554",
+    "@aztec/simulator": "0.0.1-commit.e61ad554",
+    "@aztec/stdlib": "0.0.1-commit.e61ad554",
     "koa": "^2.16.1",
     "koa-router": "^13.1.1",
     "lodash.omit": "^4.5.0",
@@ -82,14 +82,14 @@
     "viem": "npm:@aztec/viem@2.38.2"
   },
   "devDependencies": {
-    "@aztec/merkle-tree": "0.0.1-commit.d3ec352c",
-    "@aztec/noir-test-contracts.js": "0.0.1-commit.d3ec352c",
+    "@aztec/merkle-tree": "0.0.1-commit.e61ad554",
+    "@aztec/noir-test-contracts.js": "0.0.1-commit.e61ad554",
     "@jest/globals": "^30.0.0",
     "@types/jest": "^30.0.0",
     "@types/lodash.omit": "^4.5.7",
     "@types/lodash.times": "^4.3.9",
     "@types/node": "^22.15.17",
-    "@typescript/native-preview": "7.0.0-dev.20251126.1",
+    "@typescript/native-preview": "7.0.0-dev.20260113.1",
     "jest": "^30.0.0",
     "jest-mock-extended": "^4.0.0",
     "lodash.times": "^4.3.2",

package/src/bin/check_oracle_version.ts

@@ -1,6 +1,11 @@
-import { keccak256String } from '@aztec/foundation/crypto';
+/* eslint-disable import-x/no-named-as-default-member */
+import { keccak256String } from '@aztec/foundation/crypto/keccak';
+
+import { readFileSync } from 'fs';
+import { dirname, join } from 'path';
+import ts from 'typescript';
+import { fileURLToPath } from 'url';
 
-import { Oracle } from '../contract_function_simulator/oracle/oracle.js';
 import { ORACLE_INTERFACE_HASH } from '../oracle_version.js';
 
 /**
@@ -16,6 +21,22 @@ import { ORACLE_INTERFACE_HASH } from '../oracle_version.js';
  * oracle interface like we do in PXE (i.e., there is no single Oracle class that contains only the oracles).
  */
 function assertOracleInterfaceMatches(): void {
+  const oracleInterfaceSignature = getOracleInterfaceSignature();
+
+  // We use keccak256 here just because we already have it in the dependencies.
+  const oracleInterfaceHash = keccak256String(oracleInterfaceSignature);
+  if (oracleInterfaceHash !== ORACLE_INTERFACE_HASH) {
+    // This check exists only to notify you when you need to update the ORACLE_VERSION constant.
+    throw new Error(
+      `The Oracle interface has changed, which implies a breaking change in the aztec.nr/PXE oracle interface. Update ORACLE_INTERFACE_HASH to ${oracleInterfaceHash} and bump ORACLE_VERSION in pxe/src/oracle_version.ts.`,
+    );
+  }
+}
+
+/**
+ * Constructs a signature of the Oracle interface while ignoring methods that are not foreign call handlers.
+ */
+function getOracleInterfaceSignature(): string {
   const excludedProps = [
     'handler',
     'constructor',
@@ -25,26 +46,116 @@ function assertOracleInterfaceMatches(): void {
     'handlerAsPrivate',
   ] as const;
 
-  // Create a hashable representation of the oracle interface by concatenating its method names. Return values are
-  // excluded from the hash calculation since they are typically arrays of fields and I didn't manage to reliably
-  // stringify them.
-  // TODO(#16581): we're only checking the functions implemented by the Oracle object, which is really an ACVM
-  // translator, akin to TXE's RPC translator. This is correct in that it is ultimately the foreign interface that
-  // matters, but incorrect in that it does not take into consideration TXE's extended interface. An improvement would
-  // be to check RPCTranslator from TXE, though that still seems a bit fragile.
-  const oracleInterfaceMethodNames = Object.getOwnPropertyNames(Oracle.prototype)
-    .filter(name => !excludedProps.includes(name as (typeof excludedProps)[number]))
-    .sort()
-    .join('');
+  // Get the path to Oracle.ts source file
+  // The script runs from dest/bin/ after compilation, so we need to go up to the package root
+  // then into src/ to find the source file
+  const currentDir = dirname(fileURLToPath(import.meta.url));
+  // Go up from dest/bin/ or src/bin/ to the package root (pxe/), then into src/
+  const packageRoot = dirname(dirname(currentDir)); // Go up from bin/ to pxe/
+  const oracleSourcePath = join(packageRoot, 'src/contract_function_simulator/oracle/oracle.ts');
 
-  // We use keccak256 here just because we already have it in the dependencies.
-  const oracleInterfaceHash = keccak256String(oracleInterfaceMethodNames);
-  if (oracleInterfaceHash !== ORACLE_INTERFACE_HASH) {
-    // This check exists only to notify you when you need to update the ORACLE_VERSION constant.
-    throw new Error(
-      `The Oracle interface has changed, which implies a breaking change in the aztec.nr/PXE oracle interface. Update ORACLE_INTERFACE_HASH to ${oracleInterfaceHash} and bump ORACLE_VERSION in pxe/src/oracle_version.ts.`,
-    );
+  // Read and parse the TypeScript source file
+  const sourceCode = readFileSync(oracleSourcePath, 'utf-8');
+  const sourceFile = ts.createSourceFile('oracle.ts', sourceCode, ts.ScriptTarget.Latest, true, ts.ScriptKind.TS);
+
+  // Extract method signatures from the Oracle class
+  const methodSignatures: string[] = [];
+
+  function visit(node: ts.Node) {
+    // Look for class declaration named "Oracle"
+    if (ts.isClassDeclaration(node) && node.name?.text === 'Oracle') {
+      // Visit all members of the class
+      node.members.forEach(member => {
+        if (ts.isMethodDeclaration(member) && member.name && ts.isIdentifier(member.name)) {
+          const methodName = member.name.text;
+
+          // Skip excluded methods
+          if (excludedProps.includes(methodName as (typeof excludedProps)[number])) {
+            return;
+          }
+
+          // Extract parameter signatures
+          const paramSignatures: string[] = [];
+          member.parameters.forEach(param => {
+            const paramName = extractParameterName(param, sourceFile);
+            const paramType = extractTypeString(param.type, sourceFile);
+            paramSignatures.push(`${paramName}: ${paramType}`);
+          });
+
+          // Extract return type
+          const returnType = extractTypeString(member.type, sourceFile);
+
+          // Build full signature: methodName(param1: Type1, param2: Type2): ReturnType
+          const signature = `${methodName}(${paramSignatures.join(', ')}): ${returnType}`;
+          methodSignatures.push(signature);
+        }
+      });
+    }
+
+    ts.forEachChild(node, visit);
+  }
+
+  visit(sourceFile);
+
+  // Sort signatures alphabetically for consistent hashing
+  methodSignatures.sort();
+
+  // Create a hashable representation by concatenating all signatures
+  return methodSignatures.join('');
+}
+
+/**
+ * Extracts the parameter name from a parameter node, handling destructured parameters.
+ */
+function extractParameterName(param: ts.ParameterDeclaration, sourceFile: ts.SourceFile): string {
+  const name = param.name;
+
+  if (ts.isIdentifier(name)) {
+    return name.text;
   }
+
+  if (ts.isArrayBindingPattern(name)) {
+    // Handle destructured parameters like [blockNumber]: ACVMField[]
+    // Extract the first element name
+    if (name.elements.length > 0) {
+      const element = name.elements[0];
+      if (ts.isBindingElement(element)) {
+        const elementName = element.name;
+        if (ts.isIdentifier(elementName)) {
+          return elementName.text;
+        }
+        // Nested destructuring - use text representation
+        if (ts.isArrayBindingPattern(elementName) || ts.isObjectBindingPattern(elementName)) {
+          return elementName.getText(sourceFile);
+        }
+      }
+    }
+    // Fallback: return the text representation
+    return name.getText(sourceFile);
+  }
+
+  if (ts.isObjectBindingPattern(name)) {
+    // Handle object destructuring
+    return name.getText(sourceFile);
+  }
+
+  // Fallback for any other case - this should never happen but TypeScript needs it
+  return (name as ts.Node).getText(sourceFile);
+}
+
+/**
+ * Extracts the type string from a type node, normalizing whitespace.
+ */
+function extractTypeString(typeNode: ts.TypeNode | undefined, sourceFile: ts.SourceFile): string {
+  if (!typeNode) {
+    return 'void';
+  }
+
+  // Get the type text and normalize whitespace
+  let typeText = typeNode.getText(sourceFile);
+  // Normalize whitespace: remove extra spaces, newlines, and tabs
+  typeText = typeText.replace(/\s+/g, ' ').trim();
+  return typeText;
 }
 
 assertOracleInterfaceMatches();