@aztec/pxe 0.0.1-commit.b655e406 → 0.0.1-commit.b8a057fa

package/dest/bin/check_oracle_version.d.ts

@@ -1,2 +1,2 @@
 export {};
-//# sourceMappingURL=check_oracle_version.d.ts.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2hlY2tfb3JhY2xlX3ZlcnNpb24uZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9iaW4vY2hlY2tfb3JhY2xlX3ZlcnNpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dest/bin/check_oracle_version.js

@@ -1,39 +1,63 @@
-import { keccak256String } from '@aztec/foundation/crypto';
-import { Oracle } from '../contract_function_simulator/oracle/oracle.js';
-import { ORACLE_INTERFACE_HASH } from '../oracle_version.js';
+import { keccak256String } from '@aztec/foundation/crypto/keccak';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import { ORACLE_INTERFACE_HASH, ORACLE_VERSION_MAJOR } from '../oracle_version.js';
+import { getOracleRegistrySignature, readNumericGlobal } from './oracle_version_helpers.js';
 /**
  * Verifies that the Oracle interface matches the expected interface hash.
  *
  * The Oracle interface needs to be versioned to ensure compatibility between Aztec.nr and PXE. This function computes
- * a hash of the Oracle interface and compares it against a known hash. If they don't match, it means the interface has
- * changed and the ORACLE_VERSION constant needs to be incremented and the ORACLE_INTERFACE_HASH constant needs to be
- * updated.
- *
- * TODO(#16581): The following only takes into consideration changes to the oracles defined in Oracle.ts and omits TXE
- * oracles. Ensure this checks TXE oracles as well. This hasn't been implemented yet since we don't have a clean TXE
- * oracle interface like we do in PXE (i.e., there is no single Oracle class that contains only the oracles).
+ * a hash of the `ORACLE_REGISTRY` declaration (where each oracle's parameter names, parameter types, and return type
+ * live) and compares it against a known hash. If they don't match, it means the interface has changed and the oracle
+ * version needs to be bumped:
+ *   - If the change is backward-breaking (e.g. removing/renaming an oracle, or changing its params/return), bump
+ *     ORACLE_VERSION_MAJOR.
+ *   - If the change is an oracle addition (non-breaking), bump ORACLE_VERSION_MINOR.
  */ function assertOracleInterfaceMatches() {
-    const excludedProps = [
-        'handler',
-        'constructor',
-        'toACIRCallback',
-        'handlerAsMisc',
-        'handlerAsUtility',
-        'handlerAsPrivate'
-    ];
-    // 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)).sort().join('');
+    // The script runs from dest/bin/ after compilation, so we go up to the package root then into src/ to find
+    // the source file.
+    const currentDir = dirname(fileURLToPath(import.meta.url));
+    const packageRoot = dirname(dirname(currentDir)); // Go up from bin/ to pxe/
+    const registrySourcePath = join(packageRoot, 'src/contract_function_simulator/oracle/oracle_registry.ts');
+    const oracleInterfaceSignature = getOracleRegistrySignature(registrySourcePath, 'ORACLE_REGISTRY');
     // We use keccak256 here just because we already have it in the dependencies.
-    const oracleInterfaceHash = keccak256String(oracleInterfaceMethodNames);
+    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.`);
+        throw new Error(`The Oracle interface has changed. Update ORACLE_INTERFACE_HASH to ${oracleInterfaceHash} in pxe/src/oracle_version.ts and bump the oracle version (ORACLE_VERSION_MAJOR for breaking changes, ORACLE_VERSION_MINOR for oracle additions).`);
+    }
+}
+/**
+ * Verifies that `ORACLE_VERSION_MAJOR` is identical across all of its hand-maintained copies.
+ *
+ * The major version is duplicated across the PXE TypeScript constant and two Noir constants (Aztec.nr and the protocol
+ * contracts' `aztec_sublib`) because those layers can't import each other. This static check fails fast at build time,
+ * naming each file and its value.
+ *
+ * Only the major version is checked: the minor version legitimately diverges under the "environment minor >= contract
+ * minor" tolerance, so asserting minor equality would false-positive.
+ */ function assertContractOracleVersionMajorInSync() {
+    const currentDir = dirname(fileURLToPath(import.meta.url));
+    // Go up from dest/bin/ or src/bin/ to the package root (pxe/), then up two more to the git root.
+    const packageRoot = dirname(dirname(currentDir));
+    const gitRoot = join(packageRoot, '..', '..');
+    const copies = [
+        {
+            label: 'pxe/src/oracle_version.ts',
+            value: ORACLE_VERSION_MAJOR
+        },
+        {
+            label: 'aztec-nr/aztec/src/oracle/version.nr',
+            value: readNumericGlobal(join(gitRoot, 'noir-projects/aztec-nr/aztec/src/oracle/version.nr'), 'ORACLE_VERSION_MAJOR')
+        },
+        {
+            label: 'aztec_sublib/src/oracle/version.nr',
+            value: readNumericGlobal(join(gitRoot, 'noir-projects/noir-contracts/contracts/protocol/aztec_sublib/src/oracle/version.nr'), 'ORACLE_VERSION_MAJOR')
+        }
+    ];
+    if (new Set(copies.map((copy)=>copy.value)).size > 1) {
+        const details = copies.map((copy)=>`${copy.label}=${copy.value}`).join(', ');
+        throw new Error(`ORACLE_VERSION_MAJOR is out of sync: ${details}. Bump all copies together.`);
     }
 }
 assertOracleInterfaceMatches();
+assertContractOracleVersionMajorInSync();

package/dest/bin/index.d.ts

@@ -0,0 +1,2 @@
+export { getOracleInterfaceSignature, getOracleRegistrySignature, readNumericGlobal, } from './oracle_version_helpers.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9iaW4vaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUNMLDJCQUEyQixFQUMzQiwwQkFBMEIsRUFDMUIsaUJBQWlCLEdBQ2xCLE1BQU0sNkJBQTZCLENBQUMifQ==

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/bin/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAC3B,0BAA0B,EAC1B,iBAAiB,GAClB,MAAM,6BAA6B,CAAC"}

package/dest/bin/index.js

@@ -0,0 +1 @@
+export { getOracleInterfaceSignature, getOracleRegistrySignature, readNumericGlobal } from './oracle_version_helpers.js';

package/dest/bin/oracle_version_helpers.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Extracts method signatures from TypeScript classes or interfaces and returns a deterministic string representation.
+ *
+ * This is used to detect when an oracle interface changes so that the oracle version can be bumped. It works with both
+ * class declarations (e.g. PXE's `Oracle` class) and interface declarations (e.g. TXE's `IAvmExecutionOracle`).
+ *
+ * @param sourcePath - Absolute path to the TypeScript source file to parse.
+ * @param targets - Names of classes or interfaces to extract methods from.
+ * @param excludedMembers - Method names to skip (e.g. non-oracle helpers like `constructor`).
+ */
+export declare function getOracleInterfaceSignature(sourcePath: string, targets: string[], excludedMembers: string[]): string;
+/**
+ * Extracts a deterministic signature string from an oracle registry object literal (e.g. PXE's `ORACLE_REGISTRY`).
+ *
+ * Reads the registry declaration where each oracle's wire ABI lives: the ordered parameter names with their
+ * `TypeMapping` expressions and the return type. The resulting hash is sensitive to parameter, type, and return
+ * changes, not just oracle additions and removals.
+ *
+ * Type expressions are captured as their source text (e.g. `OPTION(AZTEC_ADDRESS)`, `BOUNDED_VEC(NOTE)`), so the
+ * signature tracks the composition of types. However, if the internal serialization logic of a `TypeMapping` constant
+ * (e.g. `FIELD`) changes without the constant being renamed, the hash will not change.
+ *
+ * @example
+ * // Given a registry like:
+ * //   export const ORACLE_REGISTRY = {
+ * //     aztec_utl_foo: makeEntry({ params: [{ name: 'a', type: U32 }], returnType: BOOL }),
+ * //     aztec_prv_bar: makeEntry(),
+ * //   } satisfies Record<string, OracleRegistryEntry>;
+ * //
+ * // Returns (sorted, newline-joined):
+ * //   "aztec_prv_bar(): void\naztec_utl_foo(a: U32): BOOL"
+ *
+ * @param sourcePath - Absolute path to the TypeScript source file declaring the registry.
+ * @param registryName - Name of the registry constant to read (e.g. `ORACLE_REGISTRY`).
+ */
+export declare function getOracleRegistrySignature(sourcePath: string, registryName: string): string;
+/**
+ * Reads an integer-valued global constant from a Noir or TypeScript source file.
+ *
+ * Matches both the Noir form (`pub global NAME: Field = N;`) and the TypeScript form (`export const NAME = N;`). This
+ * lets us compare a version constant that is hand-duplicated across the TS and Noir layers (which can't import each
+ * other) without depending on either compiler. Only the assignment form `NAME = N` matches, so later usages of the
+ * constant are ignored regardless of their order in the file.
+ *
+ * @param sourcePath - Absolute path to the source file to read.
+ * @param name - Name of the global constant whose integer value should be extracted.
+ * @returns The integer value assigned to the constant.
+ * @throws If the constant's declaration is not found in the file.
+ */
+export declare function readNumericGlobal(sourcePath: string, name: string): number;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3JhY2xlX3ZlcnNpb25faGVscGVycy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2Jpbi9vcmFjbGVfdmVyc2lvbl9oZWxwZXJzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUlBOzs7Ozs7Ozs7R0FTRztBQUNILHdCQUFnQiwyQkFBMkIsQ0FBQyxVQUFVLEVBQUUsTUFBTSxFQUFFLE9BQU8sRUFBRSxNQUFNLEVBQUUsRUFBRSxlQUFlLEVBQUUsTUFBTSxFQUFFLEdBQUcsTUFBTSxDQThDcEg7QUFFRDs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0F1Qkc7QUFDSCx3QkFBZ0IsMEJBQTBCLENBQUMsVUFBVSxFQUFFLE1BQU0sRUFBRSxZQUFZLEVBQUUsTUFBTSxHQUFHLE1BQU0sQ0EwQjNGO0FBRUQ7Ozs7Ozs7Ozs7OztHQVlHO0FBQ0gsd0JBQWdCLGlCQUFpQixDQUFDLFVBQVUsRUFBRSxNQUFNLEVBQUUsSUFBSSxFQUFFLE1BQU0sR0FBRyxNQUFNLENBTzFFIn0=

package/dest/bin/oracle_version_helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"oracle_version_helpers.d.ts","sourceRoot":"","sources":["../../src/bin/oracle_version_helpers.ts"],"names":[],"mappings":"AAIA;;;;;;;;;GASG;AACH,wBAAgB,2BAA2B,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,eAAe,EAAE,MAAM,EAAE,GAAG,MAAM,CA8CpH;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CA0B3F;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAO1E"}

package/dest/bin/oracle_version_helpers.js

@@ -0,0 +1,254 @@
+/* eslint-disable import-x/no-named-as-default-member */ import { readFileSync } from 'fs';
+import ts from 'typescript';
+/**
+ * Extracts method signatures from TypeScript classes or interfaces and returns a deterministic string representation.
+ *
+ * This is used to detect when an oracle interface changes so that the oracle version can be bumped. It works with both
+ * class declarations (e.g. PXE's `Oracle` class) and interface declarations (e.g. TXE's `IAvmExecutionOracle`).
+ *
+ * @param sourcePath - Absolute path to the TypeScript source file to parse.
+ * @param targets - Names of classes or interfaces to extract methods from.
+ * @param excludedMembers - Method names to skip (e.g. non-oracle helpers like `constructor`).
+ */ export function getOracleInterfaceSignature(sourcePath, targets, excludedMembers) {
+    const sourceCode = readFileSync(sourcePath, 'utf-8');
+    const sourceFile = ts.createSourceFile(sourcePath, sourceCode, ts.ScriptTarget.Latest, true, ts.ScriptKind.TS);
+    const methodSignatures = [];
+    function visit(node) {
+        const isTarget = (ts.isClassDeclaration(node) || ts.isInterfaceDeclaration(node)) && targets.includes(node.name?.text ?? '');
+        if (isTarget) {
+            node.members.forEach((member)=>{
+                if ((ts.isMethodDeclaration(member) || ts.isMethodSignature(member)) && member.name && ts.isIdentifier(member.name)) {
+                    const methodName = member.name.text;
+                    if (excludedMembers.includes(methodName)) {
+                        return;
+                    }
+                    const paramSignatures = [];
+                    member.parameters.forEach((param)=>{
+                        const paramName = extractParameterName(param, sourceFile);
+                        const paramType = extractTypeString(param.type, sourceFile);
+                        paramSignatures.push(`${paramName}: ${paramType}`);
+                    });
+                    const returnType = extractTypeString(member.type, sourceFile);
+                    const signature = `${methodName}(${paramSignatures.join(', ')}): ${returnType}`;
+                    methodSignatures.push(signature);
+                }
+            });
+        }
+        ts.forEachChild(node, visit);
+    }
+    visit(sourceFile);
+    methodSignatures.sort();
+    return methodSignatures.join('');
+}
+/**
+ * Extracts a deterministic signature string from an oracle registry object literal (e.g. PXE's `ORACLE_REGISTRY`).
+ *
+ * Reads the registry declaration where each oracle's wire ABI lives: the ordered parameter names with their
+ * `TypeMapping` expressions and the return type. The resulting hash is sensitive to parameter, type, and return
+ * changes, not just oracle additions and removals.
+ *
+ * Type expressions are captured as their source text (e.g. `OPTION(AZTEC_ADDRESS)`, `BOUNDED_VEC(NOTE)`), so the
+ * signature tracks the composition of types. However, if the internal serialization logic of a `TypeMapping` constant
+ * (e.g. `FIELD`) changes without the constant being renamed, the hash will not change.
+ *
+ * @example
+ * // Given a registry like:
+ * //   export const ORACLE_REGISTRY = {
+ * //     aztec_utl_foo: makeEntry({ params: [{ name: 'a', type: U32 }], returnType: BOOL }),
+ * //     aztec_prv_bar: makeEntry(),
+ * //   } satisfies Record<string, OracleRegistryEntry>;
+ * //
+ * // Returns (sorted, newline-joined):
+ * //   "aztec_prv_bar(): void\naztec_utl_foo(a: U32): BOOL"
+ *
+ * @param sourcePath - Absolute path to the TypeScript source file declaring the registry.
+ * @param registryName - Name of the registry constant to read (e.g. `ORACLE_REGISTRY`).
+ */ export function getOracleRegistrySignature(sourcePath, registryName) {
+    const sourceCode = readFileSync(sourcePath, 'utf-8');
+    const sourceFile = ts.createSourceFile(sourcePath, sourceCode, ts.ScriptTarget.Latest, true, ts.ScriptKind.TS);
+    const registry = findObjectLiteral(sourceFile, registryName);
+    if (!registry) {
+        throw new Error(`Could not find oracle registry '${registryName}' in ${sourcePath}.`);
+    }
+    const oracleSignatures = registry.properties.map((property)=>{
+        if (!ts.isPropertyAssignment(property)) {
+            throw new Error(`Unexpected member in oracle registry '${registryName}': ${property.getText(sourceFile)}. Spread elements ` + `are not supported.`);
+        }
+        const oracleName = getPropertyName(property.name, sourceFile);
+        const { params, returnType } = extractRegistryEntry(property.initializer, sourceFile);
+        const paramSignatures = params.map((param)=>`${param.name}: ${param.type}`);
+        return `${oracleName}(${paramSignatures.join(', ')}): ${returnType}`;
+    });
+    oracleSignatures.sort();
+    return oracleSignatures.join('\n');
+}
+/**
+ * Reads an integer-valued global constant from a Noir or TypeScript source file.
+ *
+ * Matches both the Noir form (`pub global NAME: Field = N;`) and the TypeScript form (`export const NAME = N;`). This
+ * lets us compare a version constant that is hand-duplicated across the TS and Noir layers (which can't import each
+ * other) without depending on either compiler. Only the assignment form `NAME = N` matches, so later usages of the
+ * constant are ignored regardless of their order in the file.
+ *
+ * @param sourcePath - Absolute path to the source file to read.
+ * @param name - Name of the global constant whose integer value should be extracted.
+ * @returns The integer value assigned to the constant.
+ * @throws If the constant's declaration is not found in the file.
+ */ export function readNumericGlobal(sourcePath, name) {
+    const sourceCode = readFileSync(sourcePath, 'utf-8');
+    const match = sourceCode.match(new RegExp(`\\b${name}\\s*(?::\\s*\\w+\\s*)?=\\s*(\\d+)`));
+    if (!match) {
+        throw new Error(`Could not find numeric global '${name}' in ${sourcePath}.`);
+    }
+    return Number(match[1]);
+}
+function extractParameterName(param, sourceFile) {
+    const name = param.name;
+    if (ts.isIdentifier(name)) {
+        return name.text;
+    }
+    if (ts.isArrayBindingPattern(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;
+                }
+                if (ts.isArrayBindingPattern(elementName) || ts.isObjectBindingPattern(elementName)) {
+                    return elementName.getText(sourceFile);
+                }
+            }
+        }
+        return name.getText(sourceFile);
+    }
+    if (ts.isObjectBindingPattern(name)) {
+        return name.getText(sourceFile);
+    }
+    return name.getText(sourceFile);
+}
+/** Returns the source text of a type annotation, or `'void'` if absent. */ function extractTypeString(typeNode, sourceFile) {
+    if (!typeNode) {
+        return 'void';
+    }
+    return typeNode.getText(sourceFile).replace(/\s+/g, ' ').trim();
+}
+/**
+ * Finds a top-level object-literal-valued constant by name, unwrapping `satisfies`/`as`/parenthesized wrappers.
+ *
+ * @example
+ * // `const REGISTRY = { ... } satisfies Record<string, Entry>` => the `{ ... }` ObjectLiteralExpression
+ */ function findObjectLiteral(sourceFile, name) {
+    let result;
+    function visit(node) {
+        if (ts.isVariableDeclaration(node) && ts.isIdentifier(node.name) && node.name.text === name && node.initializer) {
+            result = unwrapObjectLiteral(node.initializer);
+        }
+        ts.forEachChild(node, visit);
+    }
+    visit(sourceFile);
+    return result;
+}
+/** Peels `satisfies`, `as`, and parenthesized wrappers off an expression to reach the underlying object literal. */ function unwrapObjectLiteral(node) {
+    let current = node;
+    while(ts.isSatisfiesExpression(current) || ts.isAsExpression(current) || ts.isParenthesizedExpression(current)){
+        current = current.expression;
+    }
+    return ts.isObjectLiteralExpression(current) ? current : undefined;
+}
+/**
+ * Extracts the ordered `params` (names + type expressions) and `returnType` from a `makeEntry({ ... })` call.
+ *
+ * @example
+ * // makeEntry({ params: [{ name: 'a', type: OPTION(FIELD) }], returnType: BOOL })
+ * // => { params: [{ name: 'a', type: 'OPTION(FIELD)' }], returnType: 'BOOL' }
+ * //
+ * // makeEntry()
+ * // => { params: [], returnType: 'void' }
+ */ function extractRegistryEntry(initializer, sourceFile) {
+    if (!ts.isCallExpression(initializer)) {
+        throw new Error(`Expected a makeEntry(...) call but got: ${initializer.getText(sourceFile)}`);
+    }
+    const [arg] = initializer.arguments;
+    if (arg === undefined) {
+        return {
+            params: [],
+            returnType: 'void'
+        };
+    }
+    if (!ts.isObjectLiteralExpression(arg)) {
+        throw new Error(`Expected a makeEntry object argument but got: ${arg.getText(sourceFile)}`);
+    }
+    let params = [];
+    let returnType = 'void';
+    arg.properties.forEach((property)=>{
+        if (!ts.isPropertyAssignment(property)) {
+            throw new Error(`Unexpected makeEntry property: ${property.getText(sourceFile)}`);
+        }
+        const key = getPropertyName(property.name, sourceFile);
+        if (key === 'params') {
+            params = extractRegistryParams(property.initializer, sourceFile);
+        } else if (key === 'returnType') {
+            returnType = normalizeExpressionText(property.initializer, sourceFile);
+        } else {
+            throw new Error(`Unexpected makeEntry property '${key}'.`);
+        }
+    });
+    return {
+        params,
+        returnType
+    };
+}
+/**
+ * Extracts `{ name, type }` pairs from the `params` array literal inside a `makeEntry` call.
+ */ function extractRegistryParams(initializer, sourceFile) {
+    if (!ts.isArrayLiteralExpression(initializer)) {
+        throw new Error(`Expected a params array but got: ${initializer.getText(sourceFile)}`);
+    }
+    return initializer.elements.map((element)=>{
+        if (!ts.isObjectLiteralExpression(element)) {
+            throw new Error(`Expected a param object but got: ${element.getText(sourceFile)}`);
+        }
+        let name;
+        let type;
+        element.properties.forEach((property)=>{
+            if (!ts.isPropertyAssignment(property)) {
+                throw new Error(`Unexpected param property: ${property.getText(sourceFile)}`);
+            }
+            const key = getPropertyName(property.name, sourceFile);
+            if (key === 'name') {
+                if (!ts.isStringLiteralLike(property.initializer)) {
+                    throw new Error(`Expected a string literal param name but got: ${property.initializer.getText(sourceFile)}`);
+                }
+                name = property.initializer.text;
+            } else if (key === 'type') {
+                type = normalizeExpressionText(property.initializer, sourceFile);
+            } else {
+                throw new Error(`Unexpected param property '${key}'.`);
+            }
+        });
+        if (name === undefined || type === undefined) {
+            throw new Error(`Param missing 'name' or 'type': ${element.getText(sourceFile)}`);
+        }
+        return {
+            name,
+            type
+        };
+    });
+}
+/** Returns the text of an identifier or string-literal property name, throwing on computed or numeric names. */ function getPropertyName(name, sourceFile) {
+    if (ts.isIdentifier(name) || ts.isStringLiteralLike(name)) {
+        return name.text;
+    }
+    throw new Error(`Unsupported property name: ${name.getText(sourceFile)}`);
+}
+/**
+ * Returns the source text of an expression with all whitespace stripped for format-insensitive comparison.
+ *
+ * @example
+ * // `OPTION(\n  AZTEC_ADDRESS\n)` => `"OPTION(AZTEC_ADDRESS)"`
+ */ function normalizeExpressionText(node, sourceFile) {
+    // Type expressions are TypeMapping references and calls (identifiers, parentheses, commas, numbers) with no
+    // meaningful whitespace, so we strip it entirely to keep the signature stable across reformatting.
+    return node.getText(sourceFile).replace(/\s+/g, '');
+}

package/dest/block_synchronizer/block_stream_source.d.ts

@@ -0,0 +1,10 @@
+import { type L2BlockSource } from '@aztec/stdlib/block';
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+/**
+ * Lifts an {@link AztecNode} RPC client into the shape {@link L2BlockStream} expects.
+ * `getBlocks` requests transaction bodies so that real `L2Block` instances can be constructed. The stream no
+ * longer fetches checkpoint payloads (the `chain-checkpointed` event is a thin tip event), so `getCheckpoints`
+ * is not part of the lifted shape.
+ */
+export declare function blockStreamSourceFromAztecNode(node: AztecNode): Pick<L2BlockSource, 'getBlocks' | 'getBlockData' | 'getL2Tips'>;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmxvY2tfc3RyZWFtX3NvdXJjZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2Jsb2NrX3N5bmNocm9uaXplci9ibG9ja19zdHJlYW1fc291cmNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBOEQsS0FBSyxhQUFhLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUNySCxPQUFPLEtBQUssRUFBRSxTQUFTLEVBQUUsTUFBTSxpQ0FBaUMsQ0FBQztBQUVqRTs7Ozs7R0FLRztBQUNILHdCQUFnQiw4QkFBOEIsQ0FDNUMsSUFBSSxFQUFFLFNBQVMsR0FDZCxJQUFJLENBQUMsYUFBYSxFQUFFLFdBQVcsR0FBRyxjQUFjLEdBQUcsV0FBVyxDQUFDLENBOEJqRSJ9

package/dest/block_synchronizer/block_stream_source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"block_stream_source.d.ts","sourceRoot":"","sources":["../../src/block_synchronizer/block_stream_source.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8D,KAAK,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACrH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAEjE;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAC5C,IAAI,EAAE,SAAS,GACd,IAAI,CAAC,aAAa,EAAE,WAAW,GAAG,cAAc,GAAG,WAAW,CAAC,CA8BjE"}

package/dest/block_synchronizer/block_stream_source.js

@@ -0,0 +1,37 @@
+import { L2Block } from '@aztec/stdlib/block';
+/**
+ * Lifts an {@link AztecNode} RPC client into the shape {@link L2BlockStream} expects.
+ * `getBlocks` requests transaction bodies so that real `L2Block` instances can be constructed. The stream no
+ * longer fetches checkpoint payloads (the `chain-checkpointed` event is a thin tip event), so `getCheckpoints`
+ * is not part of the lifted shape.
+ */ export function blockStreamSourceFromAztecNode(node) {
+    return {
+        getL2Tips: ()=>node.getChainTips(),
+        async getBlockData (query) {
+            const response = await node.getBlock(query);
+            if (!response) {
+                return undefined;
+            }
+            return {
+                header: response.header,
+                archive: response.archive,
+                blockHash: response.hash,
+                checkpointNumber: response.checkpointNumber,
+                indexWithinCheckpoint: response.indexWithinCheckpoint
+            };
+        },
+        async getBlocks (query) {
+            // Epoch lookups are not exposed on the public AztecNode RPC; only `from + limit` is.
+            if (!('from' in query)) {
+                throw new Error('getBlocks with epoch query not supported via AztecNode RPC');
+            }
+            if (query.onlyCheckpointed) {
+                throw new Error('getBlocks with onlyCheckpointed not supported via AztecNode RPC');
+            }
+            const responses = await node.getBlocks(query.from, query.limit, {
+                includeTransactions: true
+            });
+            return responses.map((r)=>new L2Block(r.archive, r.header, r.body, r.checkpointNumber, r.indexWithinCheckpoint));
+        }
+    };
+}

package/dest/block_synchronizer/block_synchronizer.d.ts

@@ -0,0 +1,53 @@
+import { type LoggerBindings } from '@aztec/foundation/log';
+import type { AztecAsyncKVStore } from '@aztec/kv-store';
+import type { L2TipsKVStore } from '@aztec/kv-store/stores';
+import { L2BlockStream, type L2BlockStreamEvent, type L2BlockStreamEventHandler } from '@aztec/stdlib/block';
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+import type { BlockSynchronizerConfig } from '../config/index.js';
+import type { ContractClassService } from '../contract/contract_class_service.js';
+import type { ContractSyncService } from '../contract/contract_sync_service.js';
+import type { AnchorBlockStore } from '../storage/anchor_block_store/index.js';
+import type { FactStore } from '../storage/fact_store/fact_store.js';
+import type { NoteStore } from '../storage/note_store/index.js';
+import type { PrivateEventStore } from '../storage/private_event_store/private_event_store.js';
+/**
+ * The BlockSynchronizer class orchestrates synchronization between PXE and Aztec node, maintaining an up-to-date
+ * view of the L2 chain state. It handles block header retrieval, chain reorganizations, and provides an interface
+ * for querying sync status.
+ */
+export declare class BlockSynchronizer implements L2BlockStreamEventHandler {
+    private readonly node;
+    private readonly store;
+    private readonly anchorBlockStore;
+    private readonly noteStore;
+    private readonly privateEventStore;
+    private readonly factStore;
+    private readonly l2TipsStore;
+    private readonly contractSyncService;
+    private readonly contractClassService;
+    private readonly config;
+    private log;
+    private isSyncing;
+    private readonly eventQueue;
+    protected readonly blockStream: L2BlockStream;
+    constructor(node: AztecNode, store: AztecAsyncKVStore, anchorBlockStore: AnchorBlockStore, noteStore: NoteStore, privateEventStore: PrivateEventStore, factStore: FactStore, l2TipsStore: L2TipsKVStore, contractSyncService: ContractSyncService, contractClassService: ContractClassService, config?: Partial<BlockSynchronizerConfig>, bindings?: LoggerBindings);
+    protected createBlockStream(): L2BlockStream;
+    /** Handle events emitted by the block stream. Serialized to prevent concurrent mutations to anchor state. */
+    handleBlockStreamEvent(event: L2BlockStreamEvent): Promise<void>;
+    private doHandleBlockStreamEvent;
+    private updateAnchorBlockHeader;
+    /**
+     * Syncs PXE and the node by downloading the metadata of the latest blocks, allowing simulations to use
+     * recent data (e.g. notes), and handling any reorgs that might have occurred.
+     *
+     * Note this BlockSynchronizer is designed to let its users control when a synchronization is run,
+     * so this component doesn't proactively stay up to date with the blockchain.
+     *
+     * We do this so PXE can ensure data consistency.
+     */
+    sync(): Promise<void>;
+    /** Stops the block synchronizer, waiting for any in-progress sync and queued events to complete. */
+    stop(): Promise<void>;
+    private doSync;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmxvY2tfc3luY2hyb25pemVyLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYmxvY2tfc3luY2hyb25pemVyL2Jsb2NrX3N5bmNocm9uaXplci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLEVBQWUsS0FBSyxjQUFjLEVBQWdCLE1BQU0sdUJBQXVCLENBQUM7QUFFdkYsT0FBTyxLQUFLLEVBQUUsaUJBQWlCLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQztBQUN6RCxPQUFPLEtBQUssRUFBRSxhQUFhLEVBQUUsTUFBTSx3QkFBd0IsQ0FBQztBQUM1RCxPQUFPLEVBQWEsYUFBYSxFQUFFLEtBQUssa0JBQWtCLEVBQUUsS0FBSyx5QkFBeUIsRUFBRSxNQUFNLHFCQUFxQixDQUFDO0FBQ3hILE9BQU8sS0FBSyxFQUFFLFNBQVMsRUFBRSxNQUFNLGlDQUFpQyxDQUFDO0FBR2pFLE9BQU8sS0FBSyxFQUFFLHVCQUF1QixFQUFFLE1BQU0sb0JBQW9CLENBQUM7QUFDbEUsT0FBTyxLQUFLLEVBQUUsb0JBQW9CLEVBQUUsTUFBTSx1Q0FBdUMsQ0FBQztBQUNsRixPQUFPLEtBQUssRUFBRSxtQkFBbUIsRUFBRSxNQUFNLHNDQUFzQyxDQUFDO0FBQ2hGLE9BQU8sS0FBSyxFQUFFLGdCQUFnQixFQUFFLE1BQU0sd0NBQXdDLENBQUM7QUFDL0UsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0scUNBQXFDLENBQUM7QUFDckUsT0FBTyxLQUFLLEVBQUUsU0FBUyxFQUFFLE1BQU0sZ0NBQWdDLENBQUM7QUFDaEUsT0FBTyxLQUFLLEVBQUUsaUJBQWlCLEVBQUUsTUFBTSx1REFBdUQsQ0FBQztBQUcvRjs7OztHQUlHO0FBQ0gscUJBQWEsaUJBQWtCLFlBQVcseUJBQXlCO0lBTy9ELE9BQU8sQ0FBQyxRQUFRLENBQUMsSUFBSTtJQUNyQixPQUFPLENBQUMsUUFBUSxDQUFDLEtBQUs7SUFDdEIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxnQkFBZ0I7SUFDakMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxTQUFTO0lBQzFCLE9BQU8sQ0FBQyxRQUFRLENBQUMsaUJBQWlCO0lBQ2xDLE9BQU8sQ0FBQyxRQUFRLENBQUMsU0FBUztJQUMxQixPQUFPLENBQUMsUUFBUSxDQUFDLFdBQVc7SUFDNUIsT0FBTyxDQUFDLFFBQVEsQ0FBQyxtQkFBbUI7SUFDcEMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxvQkFBb0I7SUFDckMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxNQUFNO0lBZnpCLE9BQU8sQ0FBQyxHQUFHLENBQVM7SUFDcEIsT0FBTyxDQUFDLFNBQVMsQ0FBNEI7SUFDN0MsT0FBTyxDQUFDLFFBQVEsQ0FBQyxVQUFVLENBQXFCO0lBQ2hELFNBQVMsQ0FBQyxRQUFRLENBQUMsV0FBVyxFQUFFLGFBQWEsQ0FBQztJQUU5QyxZQUNtQixJQUFJLEVBQUUsU0FBUyxFQUNmLEtBQUssRUFBRSxpQkFBaUIsRUFDeEIsZ0JBQWdCLEVBQUUsZ0JBQWdCLEVBQ2xDLFNBQVMsRUFBRSxTQUFTLEVBQ3BCLGlCQUFpQixFQUFFLGlCQUFpQixFQUNwQyxTQUFTLEVBQUUsU0FBUyxFQUNwQixXQUFXLEVBQUUsYUFBYSxFQUMxQixtQkFBbUIsRUFBRSxtQkFBbUIsRUFDeEMsb0JBQW9CLEVBQUUsb0JBQW9CLEVBQzFDLE1BQU0sR0FBRSxPQUFPLENBQUMsdUJBQXVCLENBQU0sRUFDOUQsUUFBUSxDQUFDLEVBQUUsY0FBYyxFQUsxQjtJQUVELFNBQVMsQ0FBQyxpQkFBaUIsSUFBSSxhQUFhLENBWTNDO0lBRUQsNkdBQTZHO0lBQ3RHLHNCQUFzQixDQUFDLEtBQUssRUFBRSxrQkFBa0IsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBRXRFO1lBRWEsd0JBQXdCO1lBOEd4Qix1QkFBdUI7SUFlckM7Ozs7Ozs7O09BUUc7SUFDVSxJQUFJLGtCQWlCaEI7SUFFRCxvR0FBb0c7SUFDdkYsSUFBSSxrQkFJaEI7WUFFYSxNQUFNO0NBY3JCIn0=

package/dest/block_synchronizer/block_synchronizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"block_synchronizer.d.ts","sourceRoot":"","sources":["../../src/block_synchronizer/block_synchronizer.ts"],"names":[],"mappings":"AACA,OAAO,EAAe,KAAK,cAAc,EAAgB,MAAM,uBAAuB,CAAC;AAEvF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAa,aAAa,EAAE,KAAK,kBAAkB,EAAE,KAAK,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AACxH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAGjE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAC/E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AACrE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uDAAuD,CAAC;AAG/F;;;;GAIG;AACH,qBAAa,iBAAkB,YAAW,yBAAyB;IAO/D,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,mBAAmB;IACpC,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM;IAfzB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,SAAS,CAA4B;IAC7C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqB;IAChD,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAC;IAE9C,YACmB,IAAI,EAAE,SAAS,EACf,KAAK,EAAE,iBAAiB,EACxB,gBAAgB,EAAE,gBAAgB,EAClC,SAAS,EAAE,SAAS,EACpB,iBAAiB,EAAE,iBAAiB,EACpC,SAAS,EAAE,SAAS,EACpB,WAAW,EAAE,aAAa,EAC1B,mBAAmB,EAAE,mBAAmB,EACxC,oBAAoB,EAAE,oBAAoB,EAC1C,MAAM,GAAE,OAAO,CAAC,uBAAuB,CAAM,EAC9D,QAAQ,CAAC,EAAE,cAAc,EAK1B;IAED,SAAS,CAAC,iBAAiB,IAAI,aAAa,CAY3C;IAED,6GAA6G;IACtG,sBAAsB,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAEtE;YAEa,wBAAwB;YA8GxB,uBAAuB;IAerC;;;;;;;;OAQG;IACU,IAAI,kBAiBhB;IAED,oGAAoG;IACvF,IAAI,kBAIhB;YAEa,MAAM;CAcrB"}