refactor(avm): getNullifierIndex -> checkNullifierExists

yarn-project/simulator/src/common/debug_fn_name.ts

@@ -2,7 +2,7 @@ import type { Fr } from '@aztec/foundation/fields';
 import { FunctionSelector } from '@aztec/stdlib/abi';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 
-import type { PublicContractsDBInterface } from './db_interfaces.js';
+import type { PublicContractsDBInterface } from '../public/db_interfaces.js';
 
 export async function getPublicFunctionDebugName(
   db: PublicContractsDBInterface,

yarn-project/simulator/src/common/index.ts

@@ -1,3 +1,2 @@
 export * from './errors.js';
 export * from './stats/index.js';
-export * from './message_load_oracle_inputs.js';

yarn-project/simulator/src/private/acvm/oracle/typed_oracle.ts

@@ -9,7 +9,7 @@ import type { Note, NoteStatus } from '@aztec/stdlib/note';
 import { type MerkleTreeId, type NullifierMembershipWitness, PublicDataWitness } from '@aztec/stdlib/trees';
 import type { BlockHeader, TxHash } from '@aztec/stdlib/tx';
 
-import type { MessageLoadOracleInputs } from '../../../common/message_load_oracle_inputs.js';
+import type { MessageLoadOracleInputs } from '../../message_load_oracle_inputs.js';
 
 /**
  * Information about a note needed during execution.

yarn-project/simulator/src/private/execution_data_provider.ts

@@ -1,3 +1,4 @@
+import type { L1_TO_L2_MSG_TREE_HEIGHT } from '@aztec/constants';
 import type { Fr, Point } from '@aztec/foundation/fields';
 import type {
   EventSelector,
@@ -14,8 +15,8 @@ import type { NoteStatus } from '@aztec/stdlib/note';
 import { type MerkleTreeId, type NullifierMembershipWitness, PublicDataWitness } from '@aztec/stdlib/trees';
 import type { BlockHeader, TxHash } from '@aztec/stdlib/tx';
 
-import type { CommitmentsDBInterface } from '../common/db_interfaces.js';
 import type { NoteData } from './acvm/index.js';
+import type { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
 
 /**
  * Error thrown when a contract is not found in the database.
@@ -38,7 +39,7 @@ export class ContractClassNotFoundError extends Error {
 /**
  * The interface for the data layer required to perform private and utility execution.
  */
-export interface ExecutionDataProvider extends CommitmentsDBInterface {
+export interface ExecutionDataProvider {
   /**
    * Returns a contract instance associated with an address, if available.
    * @param address - Address.
@@ -117,6 +118,40 @@ export interface ExecutionDataProvider extends CommitmentsDBInterface {
    */
   getNullifierIndex(nullifier: Fr): Promise<bigint | undefined>;
 
+  /**
+   * Gets the index of a nullifier in the nullifier tree.
+   * @param nullifier - The nullifier.
+   * @returns - The index of the nullifier. Undefined if it does not exist in the tree.
+   */
+  getNullifierIndex(nullifier: Fr): Promise<bigint | undefined>;
+
+  /**
+   * Returns a nullifier membership witness for the given nullifier or undefined if not found.
+   * REFACTOR: Same as getL1ToL2MembershipWitness, can be combined with aztec-node method that does almost the same thing.
+   * @param nullifier - Nullifier we're looking for.
+   */
+  getNullifierMembershipWitnessAtLatestBlock(nullifier: Fr): Promise<NullifierMembershipWitness | undefined>;
+
+  /**
+   * Fetches a message from the db, given its key.
+   * @param contractAddress - Address of a contract by which the message was emitted.
+   * @param messageHash - Hash of the message.
+   * @param secret - Secret used to compute a nullifier.
+   * @dev Contract address and secret are only used to compute the nullifier to get non-nullified messages
+   * @returns The l1 to l2 membership witness (index of message in the tree and sibling path).
+   */
+  getL1ToL2MembershipWitness(
+    contractAddress: AztecAddress,
+    messageHash: Fr,
+    secret: Fr,
+  ): Promise<MessageLoadOracleInputs<typeof L1_TO_L2_MSG_TREE_HEIGHT>>;
+
+  /**
+   * @param leafIndex the leaf to look up
+   * @returns The l1 to l2 leaf message hash or undefined if not found.
+   */
+  getL1ToL2MessageHash(leafIndex: bigint): Promise<Fr | undefined>;
+
   /**
    * Retrieve the databases view of the Block Header object.
    * This structure is fed into the circuits simulator and is used to prove against certain historical roots.
@@ -263,6 +298,13 @@ export interface ExecutionDataProvider extends CommitmentsDBInterface {
     recipient: AztecAddress,
   ): Promise<void>;
 
+  /**
+   * Gets note hash in the note hash tree at the given leaf index.
+   * @param leafIndex - the leaf to look up.
+   * @returns - The note hash at that index. Undefined if leaf index is not found.
+   */
+  getNoteHash(leafIndex: bigint): Promise<Fr | undefined>;
+
   /**
    * Searches for a log with the corresponding `tag` and returns it along with contextual transaction information.
    * Returns null if no such log exists, and throws if more than one exists.

yarn-project/simulator/src/private/index.ts

@@ -13,3 +13,4 @@ export { extractCallStack } from './acvm/acvm.js';
 export { type NoteData, TypedOracle } from './acvm/oracle/typed_oracle.js';
 export { Oracle } from './acvm/oracle/oracle.js';
 export { HashedValuesCache } from './hashed_values_cache.js';
+export { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';

yarn-project/simulator/src/private/private_execution.test.ts

@@ -64,9 +64,9 @@ import { jest } from '@jest/globals';
 import { Matcher, type MatcherCreator, type MockProxy, mock } from 'jest-mock-extended';
 import { toFunctionSelector } from 'viem';
 
-import { MessageLoadOracleInputs } from '../common/message_load_oracle_inputs.js';
 import { buildL1ToL2Message } from '../test/utils.js';
 import type { ExecutionDataProvider } from './execution_data_provider.js';
+import { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
 import { WASMSimulator } from './providers/acvm_wasm.js';
 import { AcirSimulator } from './simulator.js';
 

yarn-project/simulator/src/public/avm/avm_simulator.test.ts

@@ -75,10 +75,10 @@ import {
 import { encodeToBytecode } from './serialization/bytecode_serialization.js';
 import { Opcode } from './serialization/instruction_serialization.js';
 import {
+  mockCheckNullifierExists,
   mockGetBytecodeCommitment,
   mockGetContractClass,
   mockGetContractInstance,
-  mockGetNullifierIndex,
   mockL1ToL2MessageExists,
   mockNoteHashCount,
   mockNoteHashExists,
@@ -626,7 +626,7 @@ describe('AVM simulator: transpiled Noir contracts', () => {
         const bytecode = getAvmTestContractBytecode('nullifier_exists');
 
         if (exists) {
-          mockGetNullifierIndex(treesDB, leafIndex, siloedNullifier0);
+          mockCheckNullifierExists(treesDB, true, siloedNullifier0);
         }
 
         const results = await new AvmSimulator(context).executeBytecode(bytecode);
@@ -892,9 +892,9 @@ describe('AVM simulator: transpiled Noir contracts', () => {
         mockGetContractInstance(contractsDB, contractInstanceWithAddress);
         mockGetContractInstance(contractsDB, contractInstanceWithAddress);
         mockGetContractInstance(contractsDB, contractInstanceWithAddress);
-        mockGetNullifierIndex(treesDB, await siloAddress(contractInstanceWithAddress.address));
-        mockGetNullifierIndex(treesDB, await siloAddress(contractInstanceWithAddress.address));
-        mockGetNullifierIndex(treesDB, await siloAddress(contractInstanceWithAddress.address));
+        mockCheckNullifierExists(treesDB, true, await siloAddress(contractInstanceWithAddress.address));
+        mockCheckNullifierExists(treesDB, true, await siloAddress(contractInstanceWithAddress.address));
+        mockCheckNullifierExists(treesDB, true, await siloAddress(contractInstanceWithAddress.address));
 
         const bytecode = getAvmTestContractBytecode('test_get_contract_instance');
 
@@ -930,7 +930,7 @@ describe('AVM simulator: transpiled Noir contracts', () => {
         mockGetBytecodeCommitment(contractsDB, await computePublicBytecodeCommitment(contractClass.packedBytecode));
         const contractInstance = await makeContractInstanceFromClassId(contractClass.id);
         mockGetContractInstance(contractsDB, contractInstance);
-        mockGetNullifierIndex(treesDB, await siloAddress(contractInstance.address));
+        mockCheckNullifierExists(treesDB, true, await siloAddress(contractInstance.address));
 
         const nestedTrace = mock<PublicSideEffectTraceInterface>();
         mockTraceFork(trace, nestedTrace);
@@ -951,7 +951,7 @@ describe('AVM simulator: transpiled Noir contracts', () => {
         const contractInstance = await makeContractInstanceFromClassId(contractClass.id);
         mockGetContractInstance(contractsDB, contractInstance);
         mockGetBytecodeCommitment(contractsDB, await computePublicBytecodeCommitment(contractClass.packedBytecode));
-        mockGetNullifierIndex(treesDB, await siloAddress(contractInstance.address));
+        mockCheckNullifierExists(treesDB, true, await siloAddress(contractInstance.address));
 
         const nestedTrace = mock<PublicSideEffectTraceInterface>();
         mockTraceFork(trace, nestedTrace);
@@ -975,7 +975,7 @@ describe('AVM simulator: transpiled Noir contracts', () => {
         mockGetBytecodeCommitment(contractsDB, await computePublicBytecodeCommitment(contractClass.packedBytecode));
         const contractInstance = await makeContractInstanceFromClassId(contractClass.id);
         mockGetContractInstance(contractsDB, contractInstance);
-        mockGetNullifierIndex(treesDB, await siloAddress(contractInstance.address));
+        mockCheckNullifierExists(treesDB, true, await siloAddress(contractInstance.address));
 
         mockTraceFork(trace);
 
@@ -994,7 +994,7 @@ describe('AVM simulator: transpiled Noir contracts', () => {
         mockGetBytecodeCommitment(contractsDB, await computePublicBytecodeCommitment(contractClass.packedBytecode));
         const contractInstance = await makeContractInstanceFromClassId(contractClass.id);
         mockGetContractInstance(contractsDB, contractInstance);
-        mockGetNullifierIndex(treesDB, await siloAddress(contractInstance.address));
+        mockCheckNullifierExists(treesDB, true, await siloAddress(contractInstance.address));
 
         const nestedTrace = mock<PublicSideEffectTraceInterface>();
         mockTraceFork(trace, nestedTrace);
@@ -1021,7 +1021,7 @@ describe('AVM simulator: transpiled Noir contracts', () => {
         mockGetBytecodeCommitment(contractsDB, await computePublicBytecodeCommitment(contractClass.packedBytecode));
         const contractInstance = await makeContractInstanceFromClassId(contractClass.id);
         mockGetContractInstance(contractsDB, contractInstance);
-        mockGetNullifierIndex(treesDB, await siloAddress(contractInstance.address));
+        mockCheckNullifierExists(treesDB, true, await siloAddress(contractInstance.address));
 
         mockTraceFork(trace);
 
@@ -1043,7 +1043,7 @@ describe('AVM simulator: transpiled Noir contracts', () => {
         mockGetBytecodeCommitment(contractsDB, await computePublicBytecodeCommitment(contractClass.packedBytecode));
         const contractInstance = await makeContractInstanceFromClassId(contractClass.id);
         mockGetContractInstance(contractsDB, contractInstance);
-        mockGetNullifierIndex(treesDB, await siloAddress(contractInstance.address));
+        mockCheckNullifierExists(treesDB, true, await siloAddress(contractInstance.address));
 
         mockTraceFork(trace);
 

yarn-project/simulator/src/public/avm/opcodes/accrued_substate.test.ts

@@ -12,7 +12,7 @@ import { Field, Uint8, Uint32 } from '../avm_memory_types.js';
 import { InstructionExecutionError, StaticCallAlterationError } from '../errors.js';
 import { initContext, initExecutionEnvironment, initPersistableStateManager } from '../fixtures/index.js';
 import {
-  mockGetNullifierIndex,
+  mockCheckNullifierExists,
   mockL1ToL2MessageExists,
   mockNoteHashCount,
   mockNoteHashExists,
@@ -159,7 +159,7 @@ describe('Accrued Substate', () => {
         const addressOffset = 1;
 
         if (exists) {
-          mockGetNullifierIndex(treesDB, leafIndex, value0);
+          mockCheckNullifierExists(treesDB, true, value0);
         }
 
         context.machineState.memory.set(value0Offset, new Field(value0)); // nullifier
@@ -210,7 +210,7 @@ describe('Accrued Substate', () => {
     });
 
     it('Nullifier collision reverts (nullifier exists in host state)', async () => {
-      mockGetNullifierIndex(treesDB, leafIndex); // db will say that nullifier already exists
+      mockCheckNullifierExists(treesDB, true, leafIndex);
       context.machineState.memory.set(value0Offset, new Field(value0));
       await expect(new EmitNullifier(/*indirect=*/ 0, /*offset=*/ value0Offset).execute(context)).rejects.toThrow(
         new InstructionExecutionError(

yarn-project/simulator/src/public/avm/opcodes/external_calls.test.ts

@@ -13,10 +13,10 @@ import { initContext, initPersistableStateManager } from '../fixtures/index.js';
 import { encodeToBytecode } from '../serialization/bytecode_serialization.js';
 import { Opcode } from '../serialization/instruction_serialization.js';
 import {
+  mockCheckNullifierExists,
   mockGetBytecodeCommitment,
   mockGetContractClass,
   mockGetContractInstance,
-  mockGetNullifierIndex,
   mockTraceFork,
 } from '../test_utils.js';
 import { EnvironmentVariable, GetEnvVar } from './environment_getters.js';
@@ -128,7 +128,7 @@ describe('External Calls', () => {
       mockGetBytecodeCommitment(contractsDB, await computePublicBytecodeCommitment(contractClass.packedBytecode));
       const contractInstance = await makeContractInstanceFromClassId(contractClass.id);
       mockGetContractInstance(contractsDB, contractInstance);
-      mockGetNullifierIndex(treesDB, contractInstance.address.toField());
+      mockCheckNullifierExists(treesDB, true, contractInstance.address.toField());
 
       const { l2GasLeft: initialL2Gas, daGasLeft: initialDaGas } = context.machineState;
 
@@ -174,14 +174,14 @@ describe('External Calls', () => {
         new Set(/*indirect=*/ 0, /*dstOffset=*/ 1, TypeTag.UINT32, 1).as(Opcode.SET_8, Set.wireFormat8),
         new Return(/*indirect=*/ 0, /*retOffset=*/ 0, /*size=*/ 1),
       ]);
-      mockGetNullifierIndex(treesDB, addr);
+      mockCheckNullifierExists(treesDB, true, addr);
 
       const contractClass = await makeContractClassPublic(0, otherContextInstructionsBytecode);
       mockGetContractClass(contractsDB, contractClass);
       mockGetBytecodeCommitment(contractsDB, await computePublicBytecodeCommitment(contractClass.packedBytecode));
       const contractInstance = await makeContractInstanceFromClassId(contractClass.id);
       mockGetContractInstance(contractsDB, contractInstance);
-      mockGetNullifierIndex(treesDB, contractInstance.address.toField());
+      mockCheckNullifierExists(treesDB, true, contractInstance.address.toField());
 
       const { l2GasLeft: initialL2Gas, daGasLeft: initialDaGas } = context.machineState;
 
@@ -252,7 +252,7 @@ describe('External Calls', () => {
       ];
 
       const otherContextInstructionsBytecode = encodeToBytecode(otherContextInstructions);
-      mockGetNullifierIndex(treesDB, addr.toFr());
+      mockCheckNullifierExists(treesDB, true, addr.toFr());
 
       const contractClass = await makeContractClassPublic(0, otherContextInstructionsBytecode);
       mockGetContractClass(contractsDB, contractClass);

yarn-project/simulator/src/public/avm/test_utils.ts

@@ -38,8 +38,8 @@ export function mockNoteHashExists(worldStateDB: PublicTreesDB, _leafIndex: Fr,
   });
 }
 
-export function mockGetNullifierIndex(worldStateDB: PublicTreesDB, leafIndex: Fr, _ignoredValue?: Fr) {
-  (worldStateDB as jest.Mocked<PublicTreesDB>).getNullifierIndex.mockResolvedValue(leafIndex.toBigInt());
+export function mockCheckNullifierExists(worldStateDB: PublicTreesDB, exists: boolean, _ignoredValue?: Fr) {
+  (worldStateDB as jest.Mocked<PublicTreesDB>).checkNullifierExists.mockResolvedValue(exists);
 }
 
 export function mockL1ToL2MessageExists(

yarn-project/simulator/src/common/db_interfaces.ts → yarn-project/simulator/src/public/db_interfaces.ts

@@ -1,11 +1,7 @@
-import type { L1_TO_L2_MSG_TREE_HEIGHT } from '@aztec/constants';
 import type { Fr } from '@aztec/foundation/fields';
 import type { FunctionSelector } from '@aztec/stdlib/abi';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { ContractClassPublic, ContractInstanceWithAddress } from '@aztec/stdlib/contract';
-import type { NullifierMembershipWitness } from '@aztec/stdlib/trees';
-
-import type { MessageLoadOracleInputs } from './message_load_oracle_inputs.js';
 
 /**
  * Database interface for providing access to public state.
@@ -62,47 +58,3 @@ export interface PublicContractsDBInterface {
    */
   getDebugFunctionName(contractAddress: AztecAddress, selector: FunctionSelector): Promise<string | undefined>;
 }
-
-/** Database interface for providing access to note hash tree, l1 to l2 message tree, and nullifier tree. */
-export interface CommitmentsDBInterface {
-  /**
-   * Fetches a message from the db, given its key.
-   * @param contractAddress - Address of a contract by which the message was emitted.
-   * @param messageHash - Hash of the message.
-   * @param secret - Secret used to compute a nullifier.
-   * @dev Contract address and secret are only used to compute the nullifier to get non-nullified messages
-   * @returns The l1 to l2 membership witness (index of message in the tree and sibling path).
-   */
-  getL1ToL2MembershipWitness(
-    contractAddress: AztecAddress,
-    messageHash: Fr,
-    secret: Fr,
-  ): Promise<MessageLoadOracleInputs<typeof L1_TO_L2_MSG_TREE_HEIGHT>>;
-
-  /**
-   * @param leafIndex the leaf to look up
-   * @returns The l1 to l2 leaf message hash or undefined if not found.
-   */
-  getL1ToL2MessageHash(leafIndex: bigint): Promise<Fr | undefined>;
-
-  /**
-   * Gets note hash in the note hash tree at the given leaf index.
-   * @param leafIndex - the leaf to look up.
-   * @returns - The note hash at that index. Undefined if leaf index is not found.
-   */
-  getNoteHash(leafIndex: bigint): Promise<Fr | undefined>;
-
-  /**
-   * Gets the index of a nullifier in the nullifier tree.
-   * @param nullifier - The nullifier.
-   * @returns - The index of the nullifier. Undefined if it does not exist in the tree.
-   */
-  getNullifierIndex(nullifier: Fr): Promise<bigint | undefined>;
-
-  /**
-   * Returns a nullifier membership witness for the given nullifier or undefined if not found.
-   * REFACTOR: Same as getL1ToL2MembershipWitness, can be combined with aztec-node method that does almost the same thing.
-   * @param nullifier - Nullifier we're looking for.
-   */
-  getNullifierMembershipWitnessAtLatestBlock(nullifier: Fr): Promise<NullifierMembershipWitness | undefined>;
-}

yarn-project/simulator/src/public/hinting_db_sources.ts

@@ -38,7 +38,7 @@ import {
 
 import { strict as assert } from 'assert';
 
-import type { PublicContractsDBInterface } from '../common/db_interfaces.js';
+import type { PublicContractsDBInterface } from './db_interfaces.js';
 import { PublicTreesDB } from './public_db_sources.js';
 
 /**

yarn-project/simulator/src/public/index.ts

@@ -1,4 +1,4 @@
-export * from '../common/db_interfaces.js';
+export * from './db_interfaces.js';
 export * from './public_tx_simulator/index.js';
 export * from './public_db_sources.js';
 export { PublicProcessor, PublicProcessorFactory } from './public_processor/public_processor.js';