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

package/src/private_kernel/private_kernel_oracle_impl.ts

@@ -1,132 +0,0 @@
-import { NOTE_HASH_TREE_HEIGHT, PUBLIC_DATA_TREE_HEIGHT, VK_TREE_HEIGHT } from '@aztec/constants';
-import type { Fr, GrumpkinScalar, Point } from '@aztec/foundation/fields';
-import { createLogger } from '@aztec/foundation/log';
-import type { Tuple } from '@aztec/foundation/serialize';
-import { MembershipWitness } from '@aztec/foundation/trees';
-import type { KeyStore } from '@aztec/key-store';
-import { getVKIndex, getVKSiblingPath } from '@aztec/noir-protocol-circuits-types/vk-tree';
-import { ProtocolContractAddress } from '@aztec/protocol-contracts';
-import type { FunctionSelector } from '@aztec/stdlib/abi';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { L2BlockNumber } from '@aztec/stdlib/block';
-import { computeContractClassIdPreimage, computeSaltedInitializationHash } from '@aztec/stdlib/contract';
-import { DelayedPublicMutableValues, DelayedPublicMutableValuesWithHash } from '@aztec/stdlib/delayed-public-mutable';
-import { computePublicDataTreeLeafSlot } from '@aztec/stdlib/hash';
-import type { AztecNode } from '@aztec/stdlib/interfaces/client';
-import { UpdatedClassIdHints } from '@aztec/stdlib/kernel';
-import type { NullifierMembershipWitness } from '@aztec/stdlib/trees';
-import type { VerificationKeyAsFields } from '@aztec/stdlib/vks';
-
-import type { ContractDataProvider } from '../storage/index.js';
-import type { PrivateKernelOracle } from './private_kernel_oracle.js';
-
-// TODO: Block number should not be "latest".
-// It should be fixed at the time the proof is being simulated. I.e., it should be the same as the value defined in the constant data.
-
-/**
- * A data oracle that provides information needed for simulating a transaction.
- */
-export class PrivateKernelOracleImpl implements PrivateKernelOracle {
-  constructor(
-    private contractDataProvider: ContractDataProvider,
-    private keyStore: KeyStore,
-    private node: AztecNode,
-    private blockNumber: L2BlockNumber = 'latest',
-    private log = createLogger('pxe:kernel_oracle'),
-  ) {}
-
-  public async getContractAddressPreimage(address: AztecAddress) {
-    const instance = await this.contractDataProvider.getContractInstance(address);
-    if (!instance) {
-      throw new Error(`Contract instance not found when getting address preimage. Contract address: ${address}.`);
-    }
-    return {
-      saltedInitializationHash: await computeSaltedInitializationHash(instance),
-      ...instance,
-    };
-  }
-
-  public async getContractClassIdPreimage(contractClassId: Fr) {
-    const contractClass = await this.contractDataProvider.getContractClass(contractClassId);
-    if (!contractClass) {
-      throw new Error(`Contract class not found when getting class id preimage. Class id: ${contractClassId}.`);
-    }
-    return computeContractClassIdPreimage(contractClass);
-  }
-
-  public async getFunctionMembershipWitness(contractClassId: Fr, selector: FunctionSelector) {
-    const membershipWitness = await this.contractDataProvider.getFunctionMembershipWitness(contractClassId, selector);
-    if (!membershipWitness) {
-      throw new Error(
-        `Membership witness not found for contract class id ${contractClassId} and selector ${selector}.`,
-      );
-    }
-    return membershipWitness;
-  }
-
-  public getVkMembershipWitness(vk: VerificationKeyAsFields) {
-    const leafIndex = getVKIndex(vk);
-    return Promise.resolve(new MembershipWitness(VK_TREE_HEIGHT, BigInt(leafIndex), getVKSiblingPath(leafIndex)));
-  }
-
-  async getNoteHashMembershipWitness(leafIndex: bigint): Promise<MembershipWitness<typeof NOTE_HASH_TREE_HEIGHT>> {
-    const path = await this.node.getNoteHashSiblingPath(this.blockNumber, leafIndex);
-    return new MembershipWitness<typeof NOTE_HASH_TREE_HEIGHT>(
-      path.pathSize,
-      leafIndex,
-      path.toFields() as Tuple<Fr, typeof NOTE_HASH_TREE_HEIGHT>,
-    );
-  }
-
-  getNullifierMembershipWitness(nullifier: Fr): Promise<NullifierMembershipWitness | undefined> {
-    return this.node.getNullifierMembershipWitness(this.blockNumber, nullifier);
-  }
-
-  async getNoteHashTreeRoot(): Promise<Fr> {
-    const header = await this.node.getBlockHeader(this.blockNumber);
-    if (!header) {
-      throw new Error(`No block header found for block number ${this.blockNumber}`);
-    }
-    return header.state.partial.noteHashTree.root;
-  }
-
-  public getMasterSecretKey(masterPublicKey: Point): Promise<GrumpkinScalar> {
-    return this.keyStore.getMasterSecretKey(masterPublicKey);
-  }
-
-  public getDebugFunctionName(contractAddress: AztecAddress, selector: FunctionSelector): Promise<string> {
-    return this.contractDataProvider.getDebugFunctionName(contractAddress, selector);
-  }
-
-  public async getUpdatedClassIdHints(contractAddress: AztecAddress): Promise<UpdatedClassIdHints> {
-    const { delayedPublicMutableSlot, delayedPublicMutableHashSlot } =
-      await DelayedPublicMutableValuesWithHash.getContractUpdateSlots(contractAddress);
-
-    const hashLeafSlot = await computePublicDataTreeLeafSlot(
-      ProtocolContractAddress.ContractInstanceRegistry,
-      delayedPublicMutableHashSlot,
-    );
-    const updatedClassIdWitness = await this.node.getPublicDataWitness(this.blockNumber, hashLeafSlot);
-
-    if (!updatedClassIdWitness) {
-      throw new Error(`No public data tree witness found for ${hashLeafSlot}`);
-    }
-
-    const readStorage = (storageSlot: Fr) =>
-      this.node.getPublicStorageAt(this.blockNumber, ProtocolContractAddress.ContractInstanceRegistry, storageSlot);
-    const delayedPublicMutableValues = await DelayedPublicMutableValues.readFromTree(
-      delayedPublicMutableSlot,
-      readStorage,
-    );
-
-    return new UpdatedClassIdHints(
-      new MembershipWitness(
-        PUBLIC_DATA_TREE_HEIGHT,
-        updatedClassIdWitness.index,
-        updatedClassIdWitness.siblingPath.toTuple(),
-      ),
-      updatedClassIdWitness.leafPreimage,
-      delayedPublicMutableValues,
-    );
-  }
-}

package/src/storage/address_data_provider/index.ts

@@ -1 +0,0 @@
-export { AddressDataProvider } from './address_data_provider.js';

package/src/storage/capsule_data_provider/capsule_data_provider.ts

@@ -1,147 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-import { type Logger, createLogger } from '@aztec/foundation/log';
-import type { AztecAsyncKVStore, AztecAsyncMap } from '@aztec/kv-store';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-
-export class CapsuleDataProvider {
-  #store: AztecAsyncKVStore;
-
-  // Arbitrary data stored by contracts. Key is computed as `${contractAddress}:${key}`
-  #capsules: AztecAsyncMap<string, Buffer>;
-
-  logger: Logger;
-
-  constructor(store: AztecAsyncKVStore) {
-    this.#store = store;
-
-    this.#capsules = this.#store.openMap('capsules');
-
-    this.logger = createLogger('pxe:capsule-data-provider');
-  }
-
-  async storeCapsule(contractAddress: AztecAddress, slot: Fr, capsule: Fr[]): Promise<void> {
-    await this.#capsules.set(dbSlotToKey(contractAddress, slot), Buffer.concat(capsule.map(value => value.toBuffer())));
-  }
-
-  async loadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null> {
-    const dataBuffer = await this.#capsules.getAsync(dbSlotToKey(contractAddress, slot));
-    if (!dataBuffer) {
-      this.logger.trace(`Data not found for contract ${contractAddress.toString()} and slot ${slot.toString()}`);
-      return null;
-    }
-    const capsule: Fr[] = [];
-    for (let i = 0; i < dataBuffer.length; i += Fr.SIZE_IN_BYTES) {
-      capsule.push(Fr.fromBuffer(dataBuffer.subarray(i, i + Fr.SIZE_IN_BYTES)));
-    }
-    return capsule;
-  }
-
-  async deleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void> {
-    await this.#capsules.delete(dbSlotToKey(contractAddress, slot));
-  }
-
-  copyCapsule(contractAddress: AztecAddress, srcSlot: Fr, dstSlot: Fr, numEntries: number): Promise<void> {
-    return this.#store.transactionAsync(async () => {
-      // In order to support overlapping source and destination regions, we need to check the relative positions of source
-      // and destination. If destination is ahead of source, then by the time we overwrite source elements using forward
-      // indexes we'll have already read those. On the contrary, if source is ahead of destination we need to use backward
-      // indexes to avoid reading elements that've been overwritten.
-
-      const indexes = Array.from(Array(numEntries).keys());
-      if (srcSlot.lt(dstSlot)) {
-        indexes.reverse();
-      }
-
-      for (const i of indexes) {
-        const currentSrcSlot = dbSlotToKey(contractAddress, srcSlot.add(new Fr(i)));
-        const currentDstSlot = dbSlotToKey(contractAddress, dstSlot.add(new Fr(i)));
-
-        const toCopy = await this.#capsules.getAsync(currentSrcSlot);
-        if (!toCopy) {
-          throw new Error(`Attempted to copy empty slot ${currentSrcSlot} for contract ${contractAddress.toString()}`);
-        }
-
-        await this.#capsules.set(currentDstSlot, toCopy);
-      }
-    });
-  }
-
-  /**
-   * Appends multiple capsules to a capsule array stored at the base slot.
-   * The array length is stored at the base slot, and elements are stored in consecutive slots after it.
-   * All operations are performed in a single transaction.
-   * @param contractAddress - The contract address that owns the capsule array
-   * @param baseSlot - The slot where the array length is stored
-   * @param content - Array of capsule data to append
-   */
-  appendToCapsuleArray(contractAddress: AztecAddress, baseSlot: Fr, content: Fr[][]): Promise<void> {
-    return this.#store.transactionAsync(async () => {
-      // Load current length, defaulting to 0 if not found
-      const lengthData = await this.loadCapsule(contractAddress, baseSlot);
-      const currentLength = lengthData ? lengthData[0].toNumber() : 0;
-
-      // Store each capsule at consecutive slots after baseSlot + 1 + currentLength
-      for (let i = 0; i < content.length; i++) {
-        const nextSlot = arraySlot(baseSlot, currentLength + i);
-        await this.storeCapsule(contractAddress, nextSlot, content[i]);
-      }
-
-      // Update length to include all new capsules
-      const newLength = currentLength + content.length;
-      await this.storeCapsule(contractAddress, baseSlot, [new Fr(newLength)]);
-    });
-  }
-
-  readCapsuleArray(contractAddress: AztecAddress, baseSlot: Fr): Promise<Fr[][]> {
-    return this.#store.transactionAsync(async () => {
-      // Load length, defaulting to 0 if not found
-      const maybeLength = await this.loadCapsule(contractAddress, baseSlot);
-      const length = maybeLength ? maybeLength[0].toBigInt() : 0n;
-
-      const values: Fr[][] = [];
-
-      // Read each capsule at consecutive slots after baseSlot
-      for (let i = 0; i < length; i++) {
-        const currentValue = await this.loadCapsule(contractAddress, arraySlot(baseSlot, i));
-        if (currentValue == undefined) {
-          throw new Error(
-            `Expected non-empty value at capsule array in base slot ${baseSlot} at index ${i} for contract ${contractAddress}`,
-          );
-        }
-
-        values.push(currentValue);
-      }
-
-      return values;
-    });
-  }
-
-  setCapsuleArray(contractAddress: AztecAddress, baseSlot: Fr, content: Fr[][]) {
-    return this.#store.transactionAsync(async () => {
-      // Load current length, defaulting to 0 if not found
-      const maybeLength = await this.loadCapsule(contractAddress, baseSlot);
-      const originalLength = maybeLength ? maybeLength[0].toNumber() : 0;
-
-      // Set the new length
-      await this.storeCapsule(contractAddress, baseSlot, [new Fr(content.length)]);
-
-      // Store the new content, possibly overwriting existing values
-      for (let i = 0; i < content.length; i++) {
-        await this.storeCapsule(contractAddress, arraySlot(baseSlot, i), content[i]);
-      }
-
-      // Clear any stragglers
-      for (let i = content.length; i < originalLength; i++) {
-        await this.deleteCapsule(contractAddress, arraySlot(baseSlot, i));
-      }
-    });
-  }
-}
-
-function dbSlotToKey(contractAddress: AztecAddress, slot: Fr): string {
-  return `${contractAddress.toString()}:${slot.toString()}`;
-}
-
-function arraySlot(baseSlot: Fr, index: number) {
-  return baseSlot.add(new Fr(1)).add(new Fr(index));
-}

package/src/storage/capsule_data_provider/index.ts

@@ -1 +0,0 @@
-export { CapsuleDataProvider } from './capsule_data_provider.js';

package/src/storage/contract_data_provider/index.ts

@@ -1 +0,0 @@
-export { ContractDataProvider } from './contract_data_provider.js';

package/src/storage/note_data_provider/index.ts

@@ -1,2 +0,0 @@
-export { NoteDao } from './note_dao.js';
-export { NoteDataProvider } from './note_data_provider.js';

package/src/storage/note_data_provider/note_dao.ts

@@ -1,154 +0,0 @@
-import { toBigIntBE } from '@aztec/foundation/bigint-buffer';
-import { Fr, Point } from '@aztec/foundation/fields';
-import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
-import { AztecAddress } from '@aztec/stdlib/aztec-address';
-import { Note } from '@aztec/stdlib/note';
-import { TxHash } from '@aztec/stdlib/tx';
-
-import type { NoteData } from '../../contract_function_simulator/oracle/interfaces.js';
-
-/**
- * A Note Data Access Object, representing a note that was committed to the note hash tree, holding all of the
- * information required to use it during execution and manage its state.
- */
-export class NoteDao implements NoteData {
-  constructor(
-    // Note information
-
-    /** The packed content of the note, as will be returned in the getNotes oracle. */
-    public note: Note,
-    /** The address of the contract that created the note (i.e. the address used by the kernel during siloing). */
-    public contractAddress: AztecAddress,
-    /**
-     * The storage location of the note. This value is not used for anything in PXE, but we do index by storage slot
-     * since contracts typically make queries based on it.
-     */
-    public storageSlot: Fr,
-    /** The nonce that was injected into the note hash preimage in order to guarantee uniqueness. */
-    public noteNonce: Fr,
-
-    // Computed values
-    /**
-     * The inner hash (non-unique, non-siloed) of the note. Each contract determines how the note is hashed. Can
-     * be used alongside contractAddress and nonce to compute the uniqueNoteHash and the siloedNoteHash.
-     */
-    public noteHash: Fr,
-    /**
-     * The nullifier of the note, siloed by contract address.
-     * Note: Might be set as 0 if the note was added to PXE as nullified.
-     */
-    public siloedNullifier: Fr,
-
-    // Metadata
-    /** The hash of the tx in which this note was created. Knowing the tx hash allows for efficient node queries e.g.
-     *  when searching for txEffects.
-     */
-    public txHash: TxHash,
-    /** The L2 block number in which the tx with this note was included. Used for note management while processing
-     * reorgs.*/
-    public l2BlockNumber: number,
-    /** The L2 block hash in which the tx with this note was included. Used for note management while processing
-     * reorgs.*/
-    public l2BlockHash: string,
-    /** The index of the leaf in the global note hash tree the note is stored at */
-    public index: bigint,
-    /**
-     * The address whose public key was used to encrypt the note log during delivery.
-     * (This is the x-coordinate of the public key.)
-     */
-    public recipient: AztecAddress,
-  ) {}
-
-  toBuffer(): Buffer {
-    return serializeToBuffer([
-      this.note,
-      this.contractAddress,
-      this.storageSlot,
-      this.noteNonce,
-      this.noteHash,
-      this.siloedNullifier,
-      this.txHash,
-      this.l2BlockNumber,
-      Fr.fromHexString(this.l2BlockHash),
-      this.index,
-      this.recipient,
-    ]);
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-
-    const note = Note.fromBuffer(reader);
-    const contractAddress = AztecAddress.fromBuffer(reader);
-    const storageSlot = Fr.fromBuffer(reader);
-    const noteNonce = Fr.fromBuffer(reader);
-    const noteHash = Fr.fromBuffer(reader);
-    const siloedNullifier = Fr.fromBuffer(reader);
-    const txHash = reader.readObject(TxHash);
-    const l2BlockNumber = reader.readNumber();
-    const l2BlockHash = Fr.fromBuffer(reader).toString();
-    const index = toBigIntBE(reader.readBytes(32));
-    const recipient = AztecAddress.fromBuffer(reader);
-
-    return new NoteDao(
-      note,
-      contractAddress,
-      storageSlot,
-      noteNonce,
-      noteHash,
-      siloedNullifier,
-      txHash,
-      l2BlockNumber,
-      l2BlockHash,
-      index,
-      recipient,
-    );
-  }
-
-  toString() {
-    return '0x' + this.toBuffer().toString('hex');
-  }
-
-  static fromString(str: string) {
-    const hex = str.replace(/^0x/, '');
-    return NoteDao.fromBuffer(Buffer.from(hex, 'hex'));
-  }
-
-  /**
-   * Returns the size in bytes of the Note Dao.
-   * @returns - Its size in bytes.
-   */
-  public getSize() {
-    const indexSize = Math.ceil(Math.log2(Number(this.index)));
-    const noteSize = 4 + this.note.items.length * Fr.SIZE_IN_BYTES;
-    return noteSize + AztecAddress.SIZE_IN_BYTES + Fr.SIZE_IN_BYTES * 4 + TxHash.SIZE + Point.SIZE_IN_BYTES + indexSize;
-  }
-
-  static async random({
-    note = Note.random(),
-    contractAddress = undefined,
-    storageSlot = Fr.random(),
-    noteNonce = Fr.random(),
-    noteHash = Fr.random(),
-    siloedNullifier = Fr.random(),
-    txHash = TxHash.random(),
-    l2BlockNumber = Math.floor(Math.random() * 1000),
-    l2BlockHash = Fr.random().toString(),
-    index = Fr.random().toBigInt(),
-    recipient = undefined,
-  }: Partial<NoteDao> = {}) {
-    return new NoteDao(
-      note,
-      contractAddress ?? (await AztecAddress.random()),
-      storageSlot,
-      noteNonce,
-      noteHash,
-      siloedNullifier,
-      txHash,
-      l2BlockNumber,
-      l2BlockHash,
-      index,
-      recipient ?? (await AztecAddress.random()),
-    );
-  }
-}