@aztec/simulator 0.76.4 → 0.77.0-testnet-ignition.17

package/dest/public/avm/fixtures/simple_contract_data_source.js

@@ -0,0 +1,112 @@
+import { PUBLIC_DISPATCH_SELECTOR } from '@aztec/constants';
+import { createLogger } from '@aztec/foundation/log';
+import { getCanonicalFeeJuice } from '@aztec/protocol-contracts/fee-juice';
+import { FunctionSelector } from '@aztec/stdlib/abi';
+import { computeInitializationHash, computePublicBytecodeCommitment } from '@aztec/stdlib/contract';
+import { makeContractClassPublic, makeContractInstanceFromClassId } from '@aztec/stdlib/testing';
+import { PUBLIC_DISPATCH_FN_NAME, getContractFunctionArtifact } from './index.js';
+/**
+ * This class is used during public/avm testing to function as a database of
+ * contract contract classes and instances. Tests can populate it with classes
+ * and instances and then probe it via the ContractDataSource interface.
+ *
+ * This class does not include any real merkle trees & merkle operations.
+ */ export class SimpleContractDataSource {
+    logger = createLogger('simple-contract-data-source');
+    // maps contract class ID to class
+    contractClasses = new Map();
+    // maps contract instance address to instance
+    contractInstances = new Map();
+    // maps contract instance address to address
+    contractArtifacts = new Map();
+    /////////////////////////////////////////////////////////////
+    // Helper functions not in the contract data source interface
+    /**
+   * Derive the contract class and instance with some seed.
+   * Add both to the contract data source along with the contract artifact.
+   */ async registerAndDeployContract(constructorArgs, deployer, contractArtifact, seed = 0, originalContractClassId) {
+        const bytecode = getContractFunctionArtifact(PUBLIC_DISPATCH_FN_NAME, contractArtifact).bytecode;
+        const contractClass = await makeContractClassPublic(seed, /*publicDispatchFunction=*/ {
+            bytecode,
+            selector: new FunctionSelector(PUBLIC_DISPATCH_SELECTOR)
+        });
+        const constructorAbi = getContractFunctionArtifact('constructor', contractArtifact);
+        const initializationHash = await computeInitializationHash(constructorAbi, constructorArgs);
+        this.logger.trace(`Initialization hash for contract class ${contractClass.id}: ${initializationHash.toString()}`);
+        const contractInstance = originalContractClassId === undefined ? await makeContractInstanceFromClassId(contractClass.id, seed, {
+            deployer,
+            initializationHash
+        }) : await makeContractInstanceFromClassId(originalContractClassId, seed, {
+            deployer,
+            initializationHash,
+            currentClassId: contractClass.id
+        });
+        this.addContractArtifact(contractClass.id, contractArtifact);
+        await this.addContractClass(contractClass);
+        await this.addContractInstance(contractInstance);
+        return contractInstance;
+    }
+    async registerFeeJuiceContract() {
+        const feeJuice = await getCanonicalFeeJuice();
+        const feeJuiceContractClassPublic = {
+            ...feeJuice.contractClass,
+            privateFunctions: [],
+            unconstrainedFunctions: []
+        };
+        this.addContractArtifact(feeJuiceContractClassPublic.id, feeJuice.artifact);
+        await this.addContractClass(feeJuiceContractClassPublic);
+        await this.addContractInstance(feeJuice.instance);
+        return feeJuice.instance;
+    }
+    getFirstContractInstance() {
+        return this.contractInstances.values().next().value;
+    }
+    addContractArtifact(classId, artifact) {
+        this.contractArtifacts.set(classId.toString(), artifact);
+    }
+    /////////////////////////////////////////////////////////////
+    // ContractDataSource function impelementations
+    getPublicFunction(_address, _selector) {
+        throw new Error('Method not implemented.');
+    }
+    getBlockNumber() {
+        throw new Error('Method not implemented.');
+    }
+    getContractClass(id) {
+        return Promise.resolve(this.contractClasses.get(id.toString()));
+    }
+    async getBytecodeCommitment(id) {
+        const contractClass = await this.getContractClass(id);
+        return Promise.resolve(computePublicBytecodeCommitment(contractClass.packedBytecode));
+    }
+    getContract(address) {
+        return Promise.resolve(this.contractInstances.get(address.toString()));
+    }
+    getContractClassIds() {
+        throw new Error('Method not implemented.');
+    }
+    async getContractArtifact(address) {
+        const contractInstance = await this.getContract(address);
+        if (!contractInstance) {
+            this.logger.warn(`Contract not found at address: ${address}`);
+            return undefined;
+        }
+        this.logger.debug(`Retrieved contract artifact for address: ${address}`);
+        this.logger.debug(`Contract class ID: ${contractInstance.currentContractClassId}`);
+        return Promise.resolve(this.contractArtifacts.get(contractInstance.currentContractClassId.toString()));
+    }
+    getContractFunctionName(_address, _selector) {
+        return Promise.resolve(PUBLIC_DISPATCH_FN_NAME);
+    }
+    registerContractFunctionSignatures(_address, _signatures) {
+        return Promise.resolve();
+    }
+    addContractClass(contractClass) {
+        this.contractClasses.set(contractClass.id.toString(), contractClass);
+        return Promise.resolve();
+    }
+    addContractInstance(contractInstance) {
+        this.contractInstances.set(contractInstance.address.toString(), contractInstance);
+        return Promise.resolve();
+    }
+}

package/dest/public/avm/index.d.ts

@@ -0,0 +1,4 @@
+export * from './avm_simulator.js';
+export * from './journal/index.js';
+export * from './fixtures/simple_contract_data_source.js';
+//# sourceMappingURL=index.d.ts.map

package/dest/public/avm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/public/avm/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,2CAA2C,CAAC"}

package/dest/{avm/index.d.ts → public/avm/index.js}

@@ -1,4 +1,3 @@
 export * from './avm_simulator.js';
 export * from './journal/index.js';
-export * from './avm_tree.js';
-//# sourceMappingURL=index.d.ts.map
+export * from './fixtures/simple_contract_data_source.js';

package/dest/public/avm/journal/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/public/avm/journal/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/dest/{avm → public/avm}/journal/journal.d.ts

@@ -1,13 +1,28 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
-import { AztecAddress, type PublicCallRequest, SerializableContractInstance } from '@aztec/circuits.js';
 import { Fr } from '@aztec/foundation/fields';
-import { type WorldStateDB } from '../../public/public_db_sources.js';
-import { type PublicSideEffectTraceInterface } from '../../public/side_effect_trace_interface.js';
-import { type AvmExecutionEnvironment } from '../avm_execution_environment.js';
-import { AvmEphemeralForest } from '../avm_tree.js';
+import type { IndexedTreeLeafPreimage } from '@aztec/foundation/trees';
+import { AvmPublicDataReadTreeHint } from '@aztec/stdlib/avm';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { SerializableContractInstance } from '@aztec/stdlib/contract';
+import type { ContractClassWithCommitment } from '@aztec/stdlib/contract';
+import type { IndexedTreeId, MerkleTreeWriteOperations } from '@aztec/stdlib/interfaces/server';
+import type { PublicCallRequest } from '@aztec/stdlib/kernel';
+import { PublicDataTreeLeafPreimage } from '@aztec/stdlib/trees';
+import type { WorldStateDB } from '../../../public/public_db_sources.js';
+import type { PublicSideEffectTraceInterface } from '../../side_effect_trace_interface.js';
+import type { AvmExecutionEnvironment } from '../avm_execution_environment.js';
 import { NullifierManager } from './nullifiers.js';
 import { PublicStorage } from './public_storage.js';
+/**
+ * The result of fetching a leaf from an indexed tree. Contains the preimage and wether the leaf was already present
+ * or it's a low leaf.
+ */
+type GetLeafResult<T extends IndexedTreeLeafPreimage> = {
+    preimage: T;
+    leafOrLowLeafIndex: bigint;
+    alreadyPresent: boolean;
+};
 /**
  * A class to manage persistable AVM state for contract calls.
  * Maintains a cache of the current world state,
@@ -27,8 +42,8 @@ export declare class AvmPersistableStateManager {
     /** Nullifier set, including cached/recently-emitted nullifiers */
     private readonly nullifiers;
     private readonly doMerkleOperations;
-    /** Ephmeral forest for merkle tree operations */
-    merkleTrees: AvmEphemeralForest;
+    /** DB interface for merkle tree operations */
+    db: MerkleTreeWriteOperations;
     readonly firstNullifier: Fr;
     private readonly log;
     /** Make sure a forked state is never merged twice. */
@@ -42,24 +57,24 @@ export declare class AvmPersistableStateManager {
     publicStorage: PublicStorage, 
     /** Nullifier set, including cached/recently-emitted nullifiers */
     nullifiers: NullifierManager, doMerkleOperations: boolean, 
-    /** Ephmeral forest for merkle tree operations */
-    merkleTrees: AvmEphemeralForest, firstNullifier: Fr);
+    /** DB interface for merkle tree operations */
+    db: MerkleTreeWriteOperations, firstNullifier: Fr);
     /**
      * Create a new state manager
      */
-    static create(worldStateDB: WorldStateDB, trace: PublicSideEffectTraceInterface, doMerkleOperations: boolean | undefined, firstNullifier: Fr): Promise<AvmPersistableStateManager>;
+    static create(worldStateDB: WorldStateDB, trace: PublicSideEffectTraceInterface, doMerkleOperations: boolean | undefined, firstNullifier: Fr): AvmPersistableStateManager;
     /**
      * Create a new state manager forked from this one
      */
-    fork(): AvmPersistableStateManager;
+    fork(): Promise<AvmPersistableStateManager>;
     /**
      * Accept forked world state modifications & traced side effects / hints
      */
-    merge(forkedState: AvmPersistableStateManager): void;
+    merge(forkedState: AvmPersistableStateManager): Promise<void>;
     /**
      * Reject forked world state modifications & traced side effects, keep traced hints
      */
-    reject(forkedState: AvmPersistableStateManager): void;
+    reject(forkedState: AvmPersistableStateManager): Promise<void>;
     private _merge;
     /**
      * Write to public storage, journal/trace the write.
@@ -77,6 +92,12 @@ export declare class AvmPersistableStateManager {
      * @returns the latest value written to slot, or 0 if never written to before
      */
     readStorage(contractAddress: AztecAddress, slot: Fr): Promise<Fr>;
+    getPublicDataMembership(contractAddress: AztecAddress, slot: Fr): Promise<{
+        value: Fr;
+        leafPreimage: PublicDataTreeLeafPreimage;
+        leafIndex: Fr;
+        leafPath: Fr[];
+    }>;
     /**
      * Read from public storage, don't trace the read.
      *
@@ -101,14 +122,14 @@ export declare class AvmPersistableStateManager {
     writeNoteHash(contractAddress: AztecAddress, noteHash: Fr): Promise<void>;
     /**
      * Write a note hash, make it unique, trace the write.
-     * @param noteHash - the non unique note hash to write
+     * @param siloedNoteHash - the non unique note hash to write
      */
-    writeSiloedNoteHash(noteHash: Fr): Promise<void>;
+    writeSiloedNoteHash(siloedNoteHash: Fr): Promise<void>;
     /**
      * Write a note hash, trace the write.
-     * @param noteHash - the siloed unique hash to write
+     * @param uniqueNoteHash - the siloed unique hash to write
      */
-    writeUniqueNoteHash(noteHash: Fr): Promise<void>;
+    writeUniqueNoteHash(uniqueNoteHash: Fr): Promise<void>;
     /**
      * Check if a nullifier exists, trace the check.
      * @param contractAddress - address of the contract that the nullifier is associated with
@@ -167,10 +188,22 @@ export declare class AvmPersistableStateManager {
      */
     getContractInstance(contractAddress: AztecAddress): Promise<SerializableContractInstance | undefined>;
     /**
-     * Get a contract's bytecode from the contracts DB, also trace the contract class and instance
+     * Get a contract class.
+     * @param classId - class id to retrieve.
+     * @returns the contract class or undefined if it does not exist.
+     */
+    getContractClass(classId: Fr): Promise<ContractClassWithCommitment | undefined>;
+    /**
+     * Get a contract's bytecode from the contracts DB, also trace the contract class and instance indirectly.
      */
     getBytecode(contractAddress: AztecAddress): Promise<Buffer | undefined>;
+    getContractUpdateHints(contractAddress: AztecAddress): Promise<{
+        updateMembership: AvmPublicDataReadTreeHint;
+        updatePreimage: Fr[];
+    }>;
     traceEnqueuedCall(publicCallRequest: PublicCallRequest, calldata: Fr[], reverted: boolean): void;
     getPublicFunctionDebugName(avmEnvironment: AvmExecutionEnvironment): Promise<string>;
+    getLeafOrLowLeafInfo<ID extends IndexedTreeId, T extends IndexedTreeLeafPreimage>(treeId: ID, key: bigint): Promise<GetLeafResult<T>>;
 }
+export {};
 //# sourceMappingURL=journal.d.ts.map

package/dest/public/avm/journal/journal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"journal.d.ts","sourceRoot":"","sources":["../../../../src/public/avm/journal/journal.ts"],"names":[],"mappings":";;AASA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAG9C,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAEvE,OAAO,EAAE,yBAAyB,EAAmB,MAAM,mBAAmB,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAQ1E,OAAO,KAAK,EAAE,aAAa,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAChG,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAE9D,OAAO,EAAuC,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAMtG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACzE,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,sCAAsC,CAAC;AAC3F,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAA2B,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD;;;GAGG;AACH,KAAK,aAAa,CAAC,CAAC,SAAS,uBAAuB,IAAI;IACtD,QAAQ,EAAE,CAAC,CAAC;IACZ,kBAAkB,EAAE,MAAM,CAAC;IAC3B,cAAc,EAAE,OAAO,CAAC;CACzB,CAAC;AASF;;;;;;;;GAQG;AACH,qBAAa,0BAA0B;IAOnC,gCAAgC;IAChC,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,wBAAwB;aAER,KAAK,EAAE,8BAA8B;IACrD,8CAA8C;IAC9C,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,kEAAkE;IAClE,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IACnC,8CAA8C;IACvC,EAAE,EAAE,yBAAyB;aACpB,cAAc,EAAE,EAAE;IAlBpC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAA+C;IAEnE,sDAAsD;IACtD,OAAO,CAAC,uBAAuB,CAAS;;IAGtC,gCAAgC;IACf,YAAY,EAAE,YAAY;IAC3C,wBAAwB;IAER,KAAK,EAAE,8BAA8B;IACrD,8CAA8C;IAC7B,aAAa,EAAE,aAA+C;IAC/E,kEAAkE;IACjD,UAAU,EAAE,gBAAqD,EACjE,kBAAkB,EAAE,OAAe;IACpD,8CAA8C;IACvC,EAAE,EAAE,yBAAyB,EACpB,cAAc,EAAE,EAAE;IAGpC;;OAEG;WACW,MAAM,CAClB,YAAY,EAAE,YAAY,EAC1B,KAAK,EAAE,8BAA8B,EACrC,kBAAkB,qBAAiB,EACnC,cAAc,EAAE,EAAE,GACjB,0BAA0B;IAe7B;;OAEG;IACU,IAAI;IAajB;;OAEG;IACU,KAAK,CAAC,WAAW,EAAE,0BAA0B;IAI1D;;OAEG;IACU,MAAM,CAAC,WAAW,EAAE,0BAA0B;YAI7C,MAAM;IAuBpB;;;;;;OAMG;IACU,YAAY,CAAC,eAAe,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,aAAa,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAyDnH;;;;;;OAMG;IACU,WAAW,CAAC,eAAe,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;IAexE,uBAAuB,CAC3B,eAAe,EAAE,YAAY,EAC7B,IAAI,EAAE,EAAE,GACP,OAAO,CAAC;QACT,KAAK,EAAE,EAAE,CAAC;QACV,YAAY,EAAE,0BAA0B,CAAC;QACzC,SAAS,EAAE,EAAE,CAAC;QACd,QAAQ,EAAE,EAAE,EAAE,CAAC;KAChB,CAAC;IAsCF;;;;;;OAMG;IACU,WAAW,CAAC,eAAe,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;IAO9E;;;;;;;OAOG;IACU,mBAAmB,CAAC,eAAe,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAe9G;;;OAGG;IACU,aAAa,CAAC,eAAe,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAOtF;;;OAGG;IACU,mBAAmB,CAAC,cAAc,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAOnE;;;OAGG;IACU,mBAAmB,CAAC,cAAc,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAenE;;;;;OAKG;IACU,oBAAoB,CAAC,eAAe,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAuBjG;;;;;;;;;;OAUG;YACW,sBAAsB;IA+BpC;;;;OAIG;IACU,cAAc,CAAC,eAAe,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE;IAMxE;;;OAGG;IACU,oBAAoB,CAAC,eAAe,EAAE,EAAE;IAkDxC,gCAAgC,CAAC,gBAAgB,EAAE,EAAE,EAAE;IAMpE;;;;;OAKG;IACU,wBAAwB,CACnC,eAAe,EAAE,YAAY,EAC7B,OAAO,EAAE,EAAE,EACX,YAAY,EAAE,EAAE,GACf,OAAO,CAAC,OAAO,CAAC;IAgBnB;;;;;OAKG;IACI,kBAAkB,CAAC,eAAe,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE;IAKnF;;;;OAIG;IACI,cAAc,CAAC,eAAe,EAAE,YAAY,EAAE,GAAG,EAAE,EAAE,EAAE;IAK9D;;;;OAIG;IACU,mBAAmB,CAAC,eAAe,EAAE,YAAY,GAAG,OAAO,CAAC,4BAA4B,GAAG,SAAS,CAAC;IAyClH;;;;OAIG;IACU,gBAAgB,CAAC,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,2BAA2B,GAAG,SAAS,CAAC;IA4B5F;;OAEG;IACU,WAAW,CAAC,eAAe,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAoB9E,sBAAsB,CAAC,eAAe,EAAE,YAAY;;;;IAuCnD,iBAAiB,CAAC,iBAAiB,EAAE,iBAAiB,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO;IAInF,0BAA0B,CAAC,cAAc,EAAE,uBAAuB,GAAG,OAAO,CAAC,MAAM,CAAC;IAIpF,oBAAoB,CAAC,EAAE,SAAS,aAAa,EAAE,CAAC,SAAS,uBAAuB,EAC3F,MAAM,EAAE,EAAE,EACV,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;CAiB7B"}