@aztec/pxe 0.0.1-commit.5daedc8 → 0.0.1-commit.6230a0c

package/src/private_kernel/hints/compute_side_effect_uniqueness_hints.ts

@@ -1,173 +0,0 @@
-import {
-  GLOBAL_INDEX_CONTRACT_CLASS_LOG_HASH_OFFSET,
-  GLOBAL_INDEX_L2_TO_L1_MSG_OFFSET,
-  GLOBAL_INDEX_NOTE_HASH_OFFSET,
-  GLOBAL_INDEX_NOTE_HASH_READ_REQUEST_OFFSET,
-  GLOBAL_INDEX_NULLIFIER_OFFSET,
-  GLOBAL_INDEX_NULLIFIER_READ_REQUEST_OFFSET,
-  GLOBAL_INDEX_PRIVATE_CALL_REQUEST_OFFSET,
-  GLOBAL_INDEX_PRIVATE_LOG_OFFSET,
-  GLOBAL_INDEX_PUBLIC_CALL_REQUEST_OFFSET,
-  MAX_CONTRACT_CLASS_LOGS_PER_CALL,
-  MAX_ENQUEUED_CALLS_PER_CALL,
-  MAX_L2_TO_L1_MSGS_PER_CALL,
-  MAX_NOTE_HASHES_PER_CALL,
-  MAX_NOTE_HASH_READ_REQUESTS_PER_CALL,
-  MAX_NULLIFIERS_PER_CALL,
-  MAX_NULLIFIER_READ_REQUESTS_PER_CALL,
-  MAX_PRIVATE_CALL_STACK_LENGTH_PER_CALL,
-  MAX_PRIVATE_LOGS_PER_CALL,
-  TOTAL_COUNTED_SIDE_EFFECTS_PER_CALL,
-} from '@aztec/constants';
-import { makeTuple } from '@aztec/foundation/array';
-import { padArrayEnd } from '@aztec/foundation/collection';
-import type { Serializable } from '@aztec/foundation/serialize';
-import {
-  ClaimedLengthArray,
-  PrivateCallRequest,
-  type PrivateCircuitPublicInputs,
-  SideEffectCounterRange,
-  SideEffectUniquenessHints,
-} from '@aztec/stdlib/kernel';
-
-export function computeSideEffectUniquenessHints(publicInputs: PrivateCircuitPublicInputs): SideEffectUniquenessHints {
-  let sideEffectRanges: SideEffectCounterRange[] = [];
-
-  sideEffectRanges = sideEffectRanges.concat(
-    createRangesFromClaimedLengthArray(
-      publicInputs.noteHashReadRequests,
-      GLOBAL_INDEX_NOTE_HASH_READ_REQUEST_OFFSET,
-      createRangeFromCountedItem,
-    ),
-  );
-  sideEffectRanges = sideEffectRanges.concat(
-    createRangesFromClaimedLengthArray(
-      publicInputs.nullifierReadRequests,
-      GLOBAL_INDEX_NULLIFIER_READ_REQUEST_OFFSET,
-      createRangeFromCountedItem,
-    ),
-  );
-  sideEffectRanges = sideEffectRanges.concat(
-    createRangesFromClaimedLengthArray(
-      publicInputs.noteHashes,
-      GLOBAL_INDEX_NOTE_HASH_OFFSET,
-      createRangeFromCountedItem,
-    ),
-  );
-  sideEffectRanges = sideEffectRanges.concat(
-    createRangesFromClaimedLengthArray(
-      publicInputs.nullifiers,
-      GLOBAL_INDEX_NULLIFIER_OFFSET,
-      createRangeFromCountedItem,
-    ),
-  );
-  sideEffectRanges = sideEffectRanges.concat(
-    createRangesFromClaimedLengthArray(
-      publicInputs.privateCallRequests,
-      GLOBAL_INDEX_PRIVATE_CALL_REQUEST_OFFSET,
-      createRangeFromPrivateCallRequest,
-    ),
-  );
-  sideEffectRanges = sideEffectRanges.concat(
-    createRangesFromClaimedLengthArray(
-      publicInputs.publicCallRequests,
-      GLOBAL_INDEX_PUBLIC_CALL_REQUEST_OFFSET,
-      createRangeFromCountedItem,
-    ),
-  );
-  sideEffectRanges = sideEffectRanges.concat(
-    createRangesFromClaimedLengthArray(
-      publicInputs.l2ToL1Msgs,
-      GLOBAL_INDEX_L2_TO_L1_MSG_OFFSET,
-      createRangeFromCountedItem,
-    ),
-  );
-  sideEffectRanges = sideEffectRanges.concat(
-    createRangesFromClaimedLengthArray(
-      publicInputs.privateLogs,
-      GLOBAL_INDEX_PRIVATE_LOG_OFFSET,
-      createRangeFromCountedItem,
-    ),
-  );
-  sideEffectRanges = sideEffectRanges.concat(
-    createRangesFromClaimedLengthArray(
-      publicInputs.contractClassLogsHashes,
-      GLOBAL_INDEX_CONTRACT_CLASS_LOG_HASH_OFFSET,
-      createRangeFromCountedItem,
-    ),
-  );
-
-  sideEffectRanges.sort((a, b) => a.start - b.start);
-
-  const sideEffectRangeIndices = makeTuple(TOTAL_COUNTED_SIDE_EFFECTS_PER_CALL, () => 0);
-  for (let i = 0; i < sideEffectRanges.length; i++) {
-    const range = sideEffectRanges[i];
-    sideEffectRangeIndices[range.sideEffectGlobalIndex] = i;
-  }
-
-  const hints = SideEffectUniquenessHints.from({
-    sideEffectRanges: padArrayEnd(
-      sideEffectRanges,
-      SideEffectCounterRange.empty(),
-      TOTAL_COUNTED_SIDE_EFFECTS_PER_CALL,
-    ),
-    noteHashReadRequestIndices: makeTuple(
-      MAX_NOTE_HASH_READ_REQUESTS_PER_CALL,
-      i => sideEffectRangeIndices[i + GLOBAL_INDEX_NOTE_HASH_READ_REQUEST_OFFSET],
-    ),
-    nullifierReadRequestIndices: makeTuple(
-      MAX_NULLIFIER_READ_REQUESTS_PER_CALL,
-      i => sideEffectRangeIndices[i + GLOBAL_INDEX_NULLIFIER_READ_REQUEST_OFFSET],
-    ),
-    noteHashesIndices: makeTuple(
-      MAX_NOTE_HASHES_PER_CALL,
-      i => sideEffectRangeIndices[i + GLOBAL_INDEX_NOTE_HASH_OFFSET],
-    ),
-    nullifiersIndices: makeTuple(
-      MAX_NULLIFIERS_PER_CALL,
-      i => sideEffectRangeIndices[i + GLOBAL_INDEX_NULLIFIER_OFFSET],
-    ),
-    privateCallRequestsIndices: makeTuple(
-      MAX_PRIVATE_CALL_STACK_LENGTH_PER_CALL,
-      i => sideEffectRangeIndices[i + GLOBAL_INDEX_PRIVATE_CALL_REQUEST_OFFSET],
-    ),
-    publicCallRequestsIndices: makeTuple(
-      MAX_ENQUEUED_CALLS_PER_CALL,
-      i => sideEffectRangeIndices[i + GLOBAL_INDEX_PUBLIC_CALL_REQUEST_OFFSET],
-    ),
-    l2ToL1MsgsIndices: makeTuple(
-      MAX_L2_TO_L1_MSGS_PER_CALL,
-      i => sideEffectRangeIndices[i + GLOBAL_INDEX_L2_TO_L1_MSG_OFFSET],
-    ),
-    privateLogsIndices: makeTuple(
-      MAX_PRIVATE_LOGS_PER_CALL,
-      i => sideEffectRangeIndices[i + GLOBAL_INDEX_PRIVATE_LOG_OFFSET],
-    ),
-    contractClassLogsHashesIndices: makeTuple(
-      MAX_CONTRACT_CLASS_LOGS_PER_CALL,
-      i => sideEffectRangeIndices[i + GLOBAL_INDEX_CONTRACT_CLASS_LOG_HASH_OFFSET],
-    ),
-  });
-
-  return hints;
-}
-
-function createRangesFromClaimedLengthArray<T extends Serializable, N extends number>(
-  array: ClaimedLengthArray<T, N>,
-  globalIndexOffset: number,
-  rangeConstructor: (item: T, globalIndex: number) => SideEffectCounterRange,
-): SideEffectCounterRange[] {
-  const ranges = [];
-  for (let i = 0; i < array.claimedLength; i++) {
-    ranges.push(rangeConstructor(array.array[i], globalIndexOffset + i));
-  }
-  return ranges;
-}
-
-function createRangeFromCountedItem(item: { counter: number }, globalIndex: number): SideEffectCounterRange {
-  return new SideEffectCounterRange(item.counter, item.counter, globalIndex);
-}
-
-function createRangeFromPrivateCallRequest(item: PrivateCallRequest, globalIndex: number): SideEffectCounterRange {
-  return new SideEffectCounterRange(item.startSideEffectCounter, item.endSideEffectCounter, globalIndex);
-}

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 '@aztec/stdlib/note';
-export { NoteDataProvider } from './note_data_provider.js';