test(txe): extend oracle roundtrip coverage to more scalar oracles (#24550)

Author: nchamo

noir-projects/aztec-nr/aztec/src/macros/oracle_testing.nr

@@ -55,6 +55,8 @@
 //! produces two tests: `some+some` and `none+none`. Each scenario becomes its own `#[test]`, suffixed by index
 //! (`__0`, `__1`, …).
 
+use crate::messages::delivery::OnchainDeliveryMode;
+use crate::oracle::get_contract_instance::GetContractInstanceResult;
 use crate::protocol::{
     abis::function_selector::FunctionSelector,
     address::{AztecAddress, EthAddress},
@@ -143,6 +145,26 @@ impl OracleTestValue<1> for EthAddress {
         [Scenario::unnamed(EthAddress::from_field(seed as Field))]
     }
 }
+impl OracleTestValue<1> for OnchainDeliveryMode {
+    fn oracle_test_value(seed: u32) -> [Scenario<Self>; 1] {
+        // The seed alternates between the only two valid modes
+        let mode = if (seed % 2) == 0 {
+            OnchainDeliveryMode::onchain_unconstrained()
+        } else {
+            OnchainDeliveryMode::onchain_constrained()
+        };
+        [Scenario::unnamed(mode)]
+    }
+}
+impl OracleTestValue<1> for GetContractInstanceResult {
+    fn oracle_test_value(seed: u32) -> [Scenario<Self>; 1] {
+        [
+            Scenario::unnamed(
+                GetContractInstanceResult { exists: (seed % 2) != 0, member: (seed + 1) as Field },
+            ),
+        ]
+    }
+}
 impl<T> OracleTestValue<2> for Option<T>
 where
     T: OracleTestValue<1>,
@@ -390,8 +412,9 @@ pub(crate) unconstrained fn add_scenario_to_oracle_test(_name: BoundedVec<u8, MA
 global TEST_COLLECTION_LEN: u32 = 3;
 global TEST_BOUNDED_VEC_CAP: u32 = 5;
 
-/// Rewrites `typ`, replacing every array length with [`TEST_COLLECTION_LEN`] and every bounded-vec capacity with
-/// [`TEST_BOUNDED_VEC_CAP`] (recursing through `Option` inners). Returns it as a `Quoted` type to splice into the test.
+/// Rewrites `typ`, replacing every generic array length with [`TEST_COLLECTION_LEN`] and every bounded-vec capacity
+/// with [`TEST_BOUNDED_VEC_CAP`] (recursing through `Option` inners). Returns it as a `Quoted` type to splice into the
+/// test.
 ///
 /// This exists because the annotated oracles are *generic* over their lengths (e.g.
 /// `get_hash_preimage_oracle<let N: u32>(...) -> [Field; N]`), but the generated test is not generic, so it has no `N`
@@ -401,9 +424,14 @@ global TEST_BOUNDED_VEC_CAP: u32 = 5;
 comptime fn pinned_type(typ: Type) -> Quoted {
     let array = typ.as_array();
     if array.is_some() {
-        let (element_type, _generic_length) = array.unwrap();
+        let (element_type, length_type) = array.unwrap();
         let pinned_element = pinned_type(element_type);
-        let len = f"{TEST_COLLECTION_LEN}".quoted_contents();
+        // A concrete length (e.g. `[T; 1]`) is part of the oracle's signature and must be kept; only a generic
+        // length has no value to instantiate and gets pinned.
+        let len = length_type
+            .as_constant()
+            .map(|concrete_length| f"{concrete_length}".quoted_contents())
+            .unwrap_or_else(|| f"{TEST_COLLECTION_LEN}".quoted_contents());
         quote { [$pinned_element; $len] }
     } else if is_data_type_named(typ, quote { BoundedVec }) {
         let element_type = typ.as_data_type().unwrap().1[0];

noir-projects/aztec-nr/aztec/src/oracle/get_contract_instance.nr

@@ -21,9 +21,10 @@ pub fn get_contract_instance(address: AztecAddress) -> ContractInstance {
     instance
 }
 
-struct GetContractInstanceResult {
-    exists: bool,
-    member: Field,
+#[derive(Eq)]
+pub(crate) struct GetContractInstanceResult {
+    pub(crate) exists: bool,
+    pub(crate) member: Field,
 }
 
 // These oracles each return a ContractInstance member plus a boolean indicating whether the instance was found.

noir-projects/aztec-nr/aztec/src/oracle/mod.nr

@@ -37,6 +37,13 @@ pub(crate) mod ephemeral_oracles;
 pub(crate) mod transient_oracles;
 #[generate_oracle_tests]
 pub mod contract_sync;
+#[generate_oracle_tests_excluding(
+    @[
+        quote { record_fact_oracle }, // TODO: implement once we support more complex types
+        quote { get_fact_collection_oracle }, // TODO: implement once we support more complex types
+        quote { get_fact_collections_by_type_oracle }, // TODO: implement once we support more complex types
+    ],
+)]
 pub mod fact_store;
 #[generate_oracle_tests]
 pub mod public_call;
@@ -54,6 +61,11 @@ pub mod tx_phase;
 pub mod execution;
 #[generate_oracle_tests]
 pub mod execution_cache;
+#[generate_oracle_tests_excluding(
+    @[
+        quote { get_contract_instance_oracle }, // TODO: implement once we support more complex types
+    ],
+)]
 pub mod get_contract_instance;
 pub mod get_l1_to_l2_membership_witness;
 pub mod get_nullifier_membership_witness;
@@ -66,7 +78,6 @@ pub mod message_processing;
 #[generate_oracle_tests_excluding(
     @[
         quote { get_notes_oracle }, // TODO: implement once we support more complex types
-        quote { get_next_tagging_index_oracle }, // TODO: implement once we support more complex types
     ],
 )]
 pub mod notes;

yarn-project/pxe/src/contract_function_simulator/index.ts

@@ -21,6 +21,7 @@ export {
   ETH_ADDRESS,
   EVENT_VALIDATION_REQUEST,
   FIELD,
+  FIXED_ARRAY,
   FUNCTION_SELECTOR,
   LOG_RETRIEVAL_REQUEST,
   LOG_RETRIEVAL_RESPONSE,
@@ -33,6 +34,7 @@ export {
   POINT,
   PROVIDED_SECRET,
   STR,
+  STRUCT,
   U32,
   type InputSlot,
   type MaybePromise,

yarn-project/pxe/src/contract_function_simulator/oracle/oracle_type_mappings.ts

@@ -631,7 +631,7 @@ export function ARRAY<T>(inner: TypeMapping<T>): TypeMapping<T[]> & { kind: 'arr
  * zero-padded to exactly `maxLength * elementWidth` fields, and deserializes all `maxLength` elements back. An absent
  * element is the zero encoding, so the padding is derived from the shape.
  */
-function FIXED_ARRAY<T>(element: TypeMapping<T>, maxLength: number): TypeMapping<T[]> {
+export function FIXED_ARRAY<T>(element: TypeMapping<T>, maxLength: number): TypeMapping<T[]> {
   const elementWidth = fieldWidth(element.shape);
   return {
     serialization: element.serialization

yarn-project/txe/src/oracle/interfaces.ts

@@ -39,10 +39,10 @@ export interface IAvmExecutionOracle {
   nullifierExists(siloedNullifier: Fr): Promise<boolean>;
   storageWrite(slot: Fr, value: Fr): Promise<void>;
   storageRead(slot: Fr, contractAddress: AztecAddress): Promise<Fr>;
-  getContractInstanceDeployer(address: AztecAddress): Promise<{ member: Fr; exists: boolean }>;
-  getContractInstanceClassId(address: AztecAddress): Promise<{ member: Fr; exists: boolean }>;
-  getContractInstanceInitializationHash(address: AztecAddress): Promise<{ member: Fr; exists: boolean }>;
-  getContractInstanceImmutablesHash(address: AztecAddress): Promise<{ member: Fr; exists: boolean }>;
+  getContractInstanceDeployer(address: AztecAddress): Promise<{ member: Fr; exists: boolean }[]>;
+  getContractInstanceClassId(address: AztecAddress): Promise<{ member: Fr; exists: boolean }[]>;
+  getContractInstanceInitializationHash(address: AztecAddress): Promise<{ member: Fr; exists: boolean }[]>;
+  getContractInstanceImmutablesHash(address: AztecAddress): Promise<{ member: Fr; exists: boolean }[]>;
   returndataSize(): Promise<number>;
   returndataCopy(rdOffset: number, copySize: number): Promise<Fr[]>;
   call(l2Gas: number, daGas: number, address: AztecAddress, argsLength: number, args: Fr[]): Promise<void>;

yarn-project/txe/src/oracle/test-resolver/default_fixtures.ts

@@ -10,6 +10,7 @@ import {
   BOOL,
   BYTE,
   BoundedVec,
+  DELIVERY_MODE,
   ETH_ADDRESS,
   FIELD,
   FUNCTION_SELECTOR,
@@ -21,7 +22,9 @@ import {
 } from '@aztec/pxe/simulator';
 import { FunctionSelector, NoteSelector } from '@aztec/stdlib/abi';
 import { BlockHash } from '@aztec/stdlib/block';
+import { AppTaggingSecretKind } from '@aztec/stdlib/logs';
 
+import { CONTRACT_INSTANCE_MEMBER } from '../txe_oracle_registry.js';
 import type { OracleTestScenario } from './resolver.js';
 
 /**
@@ -60,6 +63,11 @@ const TEST_VALUE_IMPLS: TestValueImpl[] = [
   scalar(FUNCTION_SELECTOR, seed => FunctionSelector.fromField(new Fr(seed))),
   scalar(NOTE_SELECTOR, seed => NoteSelector.fromField(new Fr(seed))),
   scalar(BLOCK_HASH, seed => new BlockHash(new Fr(seed))),
+  // Only two delivery modes are valid for tagging, so the seed alternates between them, matching the Noir impl.
+  scalar(DELIVERY_MODE, seed =>
+    seed % 2 === 0 ? AppTaggingSecretKind.UNCONSTRAINED : AppTaggingSecretKind.CONSTRAINED,
+  ),
+  scalar(CONTRACT_INSTANCE_MEMBER, seed => [{ exists: seed % 2 !== 0, member: new Fr(seed + 1) }]),
   composite(isOption, (type, seed) => [
     named(Option.some(firstValue(type.inner, seed)), 'some'),
     named(Option.none(firstValue(type.inner, seed)), 'none'),

yarn-project/txe/src/oracle/txe_oracle_public_context.ts

@@ -125,32 +125,33 @@ 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 }> {
+  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: ContractInstancePreimageWithAddress) => Fr,
-  ): Promise<{ member: Fr; exists: boolean }> {
+  ): 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<number> {

yarn-project/txe/src/oracle/txe_oracle_registry.ts

@@ -19,6 +19,7 @@ import {
   BOOL,
   ETH_ADDRESS,
   FIELD,
+  FIXED_ARRAY,
   FUNCTION_SELECTOR,
   type InputSlot,
   type MaybePromise,
@@ -28,6 +29,7 @@ import {
   type OutputSlot,
   type ParamTypes,
   STR,
+  STRUCT,
   type SlotShape,
   type TypeMapping,
   U32,
@@ -193,10 +195,13 @@ const TXE_CALL_CONTEXT: TypeMapping<{ txHash: Fr; anchorBlockTimestamp: bigint }
   shape: ['scalar', 'scalar', 'scalar'], // discriminant, txHash, anchor block timestamp
 };
 
-const CONTRACT_INSTANCE_MEMBER: TypeMapping<{ member: Fr; exists: boolean }> = {
-  serialization: { fn: ({ member, exists }) => [member, new Fr(exists)] },
-  shape: ['scalar', 'scalar'],
-};
+export const CONTRACT_INSTANCE_MEMBER: TypeMapping<{ exists: boolean; member: Fr }[]> = FIXED_ARRAY(
+  STRUCT([
+    { name: 'exists', type: BOOL },
+    { name: 'member', type: FIELD },
+  ]),
+  1,
+);
 
 const EVENT_SELECTOR: TypeMapping<EventSelector> = {
   serialization: { fn: v => [v.toField()] },

yarn-project/txe/src/oracle/txe_oracle_version.ts

@@ -14,4 +14,4 @@ export const TXE_ORACLE_VERSION_MINOR = 2;
  *   - TXE_ORACLE_VERSION_MAJOR (and reset MINOR to 0) for breaking changes, or
  *   - TXE_ORACLE_VERSION_MINOR for additive changes (new oracle method added).
  */
-export const TXE_ORACLE_INTERFACE_HASH = 'f6694961673ada551f57f5c09fa04cd566b175e63b7b965343bd4cf02b3cbdf6';
+export const TXE_ORACLE_INTERFACE_HASH = '4ed3618087fafb4aa63c6580996a69bf6bc257844035a2019692586b5b8daf34';