@aztec/txe 0.0.1-commit.b9865e97 → 0.0.1-commit.be03c316

package/src/oracle/test-resolver/resolver.ts

@@ -1,14 +1,16 @@
 /* eslint-disable camelcase */
 import type { Logger } from '@aztec/foundation/log';
 import { createLogger } from '@aztec/foundation/log';
-import { withHexPrefix, withoutHexPrefix } from '@aztec/foundation/string';
-import type { InputSlot, OracleRegistryEntry } from '@aztec/pxe/simulator';
+import { withoutHexPrefix } from '@aztec/foundation/string';
+import { BOUNDED_VEC, BoundedVec, Option, type OracleRegistryEntry, U8, makeEntry } from '@aztec/pxe/simulator';
 
 import type { ForeignCallArgs, ForeignCallResult } from '../../utils/encoding.js';
-import type { OracleTestScenario } from './fixtures.js';
+import { toInputSlots } from '../txe_oracle_registry.js';
+import { synthesizeDefaultFixtures } from './default_fixtures.js';
 
-/** Name of the meta-oracle that Noir tests call to select a fixture scenario by name. */
+/** Name of the meta-oracle that Noir tests call to announce the next call's scenario by name. */
 const SET_SCENARIO_ORACLE = 'aztec_oracle_test_set_scenario';
+export const SET_SCENARIO_ENTRY = makeEntry({ params: [{ name: 'name', type: BOUNDED_VEC(U8) }] });
 
 export type OracleTestCallInput = {
   session_id: number;
@@ -19,12 +21,22 @@ export type OracleTestCallInput = {
 };
 
 /**
- * Oracle resolver for roundtrip tests. Selects a fixture scenario, verifies that the received inputs match, and
+ * One test case for an oracle: the expected deserialized `inputs`, the `output` to serialize back to Noir, and the
+ * `scenario` name (`some`/`none`) the matching Noir test announces. Single-scenario oracles leave `scenario` undefined
+ * and are selected automatically.
+ */
+export interface OracleTestScenario {
+  scenario?: string;
+  inputs: Record<string, unknown>;
+  output: unknown;
+}
+
+/**
+ * Oracle resolver for serialization tests. Selects a fixture scenario, verifies that the received inputs match, and
  * returns the corresponding fixture output.
  *
- * For oracles with a single fixture, it is selected automatically. For oracles with multiple fixtures, Noir tests
- * must call the `oracle_test_set_scenario` meta-oracle to select a specific scenario by name before calling the
- * real oracle.
+ * For oracles with a single scenario, it is selected automatically. For oracles with multiple scenarios, the Noir test
+ * announces the scenario by name via the `aztec_oracle_test_set_scenario` meta-oracle before calling the real oracle.
  */
 export class OracleTestResolver {
   private readonly calledOracles = new Set<string>();
@@ -39,6 +51,14 @@ export class OracleTestResolver {
     this.logger = logger ?? createLogger('txe:test-resolver');
   }
 
+  /**
+   * Builds a resolver whose fixtures are the default scenarios synthesized from the registry's type mappings. The
+   * matching Noir serialization tests are auto-generated by `#[generate_oracle_tests]` from the same convention.
+   */
+  static fromRegistry(registry: Record<string, OracleRegistryEntry>, logger?: Logger): OracleTestResolver {
+    return new OracleTestResolver(registry, synthesizeDefaultFixtures(registry), logger);
+  }
+
   // eslint-disable-next-line require-await
   async resolve_foreign_call(callData: OracleTestCallInput): Promise<ForeignCallResult> {
     const oracleName = callData.function;
@@ -48,8 +68,6 @@ export class OracleTestResolver {
       return this.#handleSetScenario(callData);
     }
 
-    this.calledOracles.add(oracleName);
-
     if (!(oracleName in this.registry)) {
       throw new Error(`Oracle '${oracleName}' not found in registry`);
     }
@@ -62,6 +80,7 @@ export class OracleTestResolver {
 
     const match = this.#selectScenario(callData.session_id, oracleName, scenarios);
     this.#verifyInputs(callData.inputs, entry, match, oracleName);
+    this.calledOracles.add(oracleName);
 
     this.logger.debug('Verified scenario for oracle', { oracleName });
 
@@ -81,62 +100,57 @@ export class OracleTestResolver {
     return Object.keys(this.registry).filter(name => !(name in this.fixtures));
   }
 
+  /**
+   * Records the scenario name for the session's next oracle call. A test announces once per multi-scenario position
+   * (param or return), so successive announcements accumulate joined with `+`, matching the names the fixture
+   * synthesizer builds (e.g. `some+some`).
+   */
   #handleSetScenario(callData: { session_id: number; inputs: ForeignCallArgs }): ForeignCallResult {
-    const charCodes = callData.inputs[0] as string[];
-    const scenarioName = charCodes
-      .map(hex => Number(BigInt(hex.startsWith('0x') ? hex : `0x${hex}`)))
-      .map(code => String.fromCharCode(code))
-      .join('');
+    const name = decodeScenarioName(callData.inputs);
+    const existing = this.pendingScenario.get(callData.session_id);
+    const scenario = existing !== undefined ? `${existing}+${name}` : name;
 
-    this.logger.debug('Setting scenario for next oracle call', { sessionId: callData.session_id, scenarioName });
-    this.pendingScenario.set(callData.session_id, scenarioName);
+    this.logger.debug('Setting scenario for next oracle call', { sessionId: callData.session_id, scenario });
+    this.pendingScenario.set(callData.session_id, scenario);
 
     return { values: [] };
   }
 
-  /** Selects a scenario by pending name (for multi-fixture oracles) or returns the single fixture. */
+  /** Selects the fixture by the announced scenario name (for multi-scenario oracles) or returns the single fixture. */
   #selectScenario(sessionId: number, oracleName: string, fixtures: OracleTestScenario[]): OracleTestScenario {
-    const selectedName = this.pendingScenario.get(sessionId);
+    const announced = this.pendingScenario.get(sessionId);
 
-    if (selectedName !== undefined) {
+    if (announced !== undefined) {
       this.pendingScenario.delete(sessionId);
-      const matches = fixtures.filter(s => s.scenario === selectedName);
-      if (matches.length === 0) {
-        const available = fixtures.map(s => s.scenario).join(', ');
-        throw new Error(`No scenario named '${selectedName}' for oracle '${oracleName}'. Available: ${available}`);
+      const match = fixtures.find(s => s.scenario === announced);
+      if (!match) {
+        const available = fixtures.map(s => s.scenario ?? '<default>').join(', ');
+        throw new Error(`No scenario '${announced}' for oracle '${oracleName}'. Available: ${available}`);
       }
-      if (matches.length > 1) {
-        throw new Error(`Duplicate scenario name '${selectedName}' for oracle '${oracleName}'`);
-      }
-      return matches[0];
+      return match;
     }
 
     if (fixtures.length === 1) {
       return fixtures[0];
     }
 
-    throw new Error(
-      `Oracle '${oracleName}' has ${fixtures.length} fixture scenarios. ` +
-        `Use #[oracle_test("scenario_name")] to select one.`,
-    );
+    throw new Error(`Oracle '${oracleName}' has ${fixtures.length} scenarios but none was announced before the call.`);
   }
 
   /** Deserializes actual inputs and verifies they match the scenario's expected inputs. */
   #verifyInputs(
     rawInputs: ForeignCallArgs,
     entry: OracleRegistryEntry,
-    scenario: OracleTestScenario,
+    fixture: OracleTestScenario,
     oracleName: string,
   ): void {
-    const expectedInputs = scenario.inputs as Record<string, unknown>;
+    const expectedInputs = fixture.inputs;
     if (Object.keys(expectedInputs).length === 0) {
       return;
     }
 
-    const normalized: InputSlot[] = rawInputs.map(v =>
-      Array.isArray(v) ? (v as string[]).map(withHexPrefix) : [withHexPrefix(v as string)],
-    );
-    const named = entry.deserializeParams(normalized);
+    const scenarioLabel = fixture.scenario ? ` (scenario '${fixture.scenario}')` : '';
+    const named = entry.deserializeParams(toInputSlots(rawInputs));
 
     for (const param of named) {
       if (!(param.name in expectedInputs)) {
@@ -146,20 +160,86 @@ export class OracleTestResolver {
         );
       }
       if (!valuesEqual(param.value, expectedInputs[param.name])) {
-        const scenarioLabel = scenario.scenario ? ` (scenario '${scenario.scenario}')` : '';
         throw new Error(
           `Input mismatch for oracle '${oracleName}'${scenarioLabel}: ` +
             `param '${param.name}' expected ${String(expectedInputs[param.name])} ` +
-            `but got ${String(param.value)}`,
+            `but got ${String(param.value)}. ${versionBumpHint(oracleName)}`,
         );
       }
     }
   }
 }
 
+/**
+ * Decodes the scenario name announced by `set_oracle_test_scenario`, whose argument is a `BoundedVec<u8, N>`
+ */
+function decodeScenarioName(inputs: ForeignCallArgs): string {
+  const [{ value }] = SET_SCENARIO_ENTRY.deserializeParams(toInputSlots(inputs));
+  return String.fromCharCode(...value.data);
+}
+
 function valuesEqual(actual: unknown, expected: unknown): boolean {
+  if (!isNonNullObject(actual) || !isNonNullObject(expected)) {
+    // Primitive scalars; String() bridges bigint vs number representations of the same seed. A primitive compared
+    // against an object is never equal.
+    return isNonNullObject(actual) === isNonNullObject(expected) && String(actual) === String(expected);
+  }
+  if (actual instanceof Option && expected instanceof Option) {
+    return actual.equals(expected, valuesEqual);
+  }
+  if (actual instanceof BoundedVec && expected instanceof BoundedVec) {
+    return actual.equals(expected, valuesEqual);
+  }
   if (Array.isArray(actual) && Array.isArray(expected)) {
     return actual.length === expected.length && actual.every((v, i) => valuesEqual(v, expected[i]));
   }
-  return String(actual) === String(expected);
+  if (isPlainObject(actual) && isPlainObject(expected)) {
+    const expectedKeys = Object.keys(expected);
+    return (
+      Object.keys(actual).length === expectedKeys.length &&
+      expectedKeys.every(key => valuesEqual(actual[key], expected[key]))
+    );
+  }
+  if (actual.constructor !== expected.constructor) {
+    return false;
+  }
+  if (hasEquals(actual)) {
+    return actual.equals(expected);
+  }
+  const actualStr = customStringForm(actual);
+  const expectedStr = customStringForm(expected);
+  if (actualStr !== undefined && expectedStr !== undefined) {
+    return actualStr === expectedStr;
+  }
+  // Comparing blindly here could pass vacuously (e.g. two '[object Object]' strings), so refuse instead.
+  throw new Error(
+    `valuesEqual cannot compare a '${actual.constructor?.name}' against a '${expected.constructor?.name}'. Add a branch for the type.`,
+  );
+}
+
+function isNonNullObject(value: unknown): value is object {
+  return typeof value === 'object' && value !== null;
+}
+
+function isPlainObject(value: unknown): value is Record<string, unknown> {
+  return isNonNullObject(value) && value.constructor === Object;
+}
+
+function hasEquals(value: object): value is { equals(other: unknown): boolean } {
+  return typeof (value as { equals?: unknown }).equals === 'function';
+}
+
+/** The value's string form when its class overrides `toString` (a meaningful representation), undefined otherwise. */
+function customStringForm(value: object): string | undefined {
+  const { toString } = value;
+  if (typeof toString !== 'function' || toString === Object.prototype.toString) {
+    return undefined;
+  }
+  return toString.call(value);
+}
+
+function versionBumpHint(oracle: string): string {
+  return oracle.startsWith('aztec_txe_') || oracle.startsWith('aztec_avm_')
+    ? 'If you changed this oracle, consider bumping the TXE oracle version in yarn-project/txe/src/oracle/txe_oracle_version.ts.'
+    : 'If you changed this oracle, consider bumping the PXE oracle version in yarn-project/pxe/src/oracle_version.ts.';
 }

package/src/oracle/txe_oracle_public_context.ts

@@ -5,7 +5,7 @@ import type { ContractStore } from '@aztec/pxe/server';
 import { PublicDataWrite } from '@aztec/stdlib/avm';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { L2Block } from '@aztec/stdlib/block';
-import type { ContractInstanceWithAddress } from '@aztec/stdlib/contract';
+import type { ContractInstancePreimageWithAddress } from '@aztec/stdlib/contract';
 import { computePublicDataTreeLeafSlot, siloNoteHash, siloNullifier } from '@aztec/stdlib/hash';
 import {
   MerkleTreeId,
@@ -125,34 +125,36 @@ export class TXEOraclePublicContext implements IAvmExecutionOracle {
     return value;
   }
 
-  getContractInstanceDeployer(address: AztecAddress): Promise<{ member: Fr; exists: boolean }> {
+  getContractInstanceDeployer(address: AztecAddress): Promise<{ member: Fr; exists: boolean }[]> {
     return this.getContractInstanceMember(address, i => i.deployer.toField());
   }
 
-  getContractInstanceClassId(address: AztecAddress): Promise<{ member: Fr; exists: boolean }> {
-    return this.getContractInstanceMember(address, i => i.currentContractClassId);
+  getContractInstanceClassId(address: AztecAddress): Promise<{ member: Fr; exists: boolean }[]> {
+    // TXE has no contract updates, so the current class always equals the original.
+    return this.getContractInstanceMember(address, i => i.originalContractClassId);
   }
 
-  getContractInstanceInitializationHash(address: AztecAddress): Promise<{ member: Fr; exists: boolean }> {
+  getContractInstanceInitializationHash(address: AztecAddress): Promise<{ member: Fr; exists: boolean }[]> {
     return this.getContractInstanceMember(address, i => i.initializationHash);
   }
 
-  getContractInstanceImmutablesHash(address: AztecAddress): Promise<{ member: Fr; exists: boolean }> {
+  getContractInstanceImmutablesHash(address: AztecAddress): Promise<{ member: Fr; exists: boolean }[]> {
     return this.getContractInstanceMember(address, i => i.immutablesHash);
   }
 
+  // The one-element array mirrors the oracles' Noir return type, `[GetContractInstanceResult; 1]`.
   private async getContractInstanceMember(
     address: AztecAddress,
-    accessor: (instance: ContractInstanceWithAddress) => Fr,
-  ): Promise<{ member: Fr; exists: boolean }> {
+    accessor: (instance: ContractInstancePreimageWithAddress) => Fr,
+  ): Promise<{ member: Fr; exists: boolean }[]> {
     const instance = await this.contractStore.getContractInstance(address);
     if (!instance) {
-      return { member: Fr.ZERO, exists: false };
+      return [{ member: Fr.ZERO, exists: false }];
     }
-    return { member: accessor(instance), exists: true };
+    return [{ member: accessor(instance), exists: true }];
   }
 
-  returndataSize(): Promise<Fr> {
+  returndataSize(): Promise<number> {
     throw new Error(
       'Contract calls are forbidden inside a `TestEnvironment::public_context`, use `public_call` instead',
     );
@@ -164,19 +166,19 @@ export class TXEOraclePublicContext implements IAvmExecutionOracle {
     );
   }
 
-  call(_l2Gas: number, _daGas: number, _address: AztecAddress, _argsLength: number, _args: Fr[]): Promise<Fr[]> {
+  call(_l2Gas: number, _daGas: number, _address: AztecAddress, _argsLength: number, _args: Fr[]): Promise<void> {
     throw new Error(
       'Contract calls are forbidden inside a `TestEnvironment::public_context`, use `public_call` instead',
     );
   }
 
-  staticCall(_l2Gas: number, _daGas: number, _address: AztecAddress, _argsLength: number, _args: Fr[]): Promise<Fr[]> {
+  staticCall(_l2Gas: number, _daGas: number, _address: AztecAddress, _argsLength: number, _args: Fr[]): Promise<void> {
     throw new Error(
       'Contract calls are forbidden inside a `TestEnvironment::public_context`, use `public_call` instead',
     );
   }
 
-  successCopy(): Promise<Fr> {
+  successCopy(): Promise<boolean> {
     throw new Error(
       'Contract calls are forbidden inside a `TestEnvironment::public_context`, use `public_call` instead',
     );