@aztec/pxe 0.0.1-commit.24de95ac → 0.0.1-commit.2606882

package/src/notes_filter.ts

@@ -0,0 +1,24 @@
+import type { Fr } from '@aztec/foundation/curves/bn254';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { NoteStatus } from '@aztec/stdlib/note';
+
+/**
+ * A filter used to fetch notes.
+ * @remarks This filter is applied as an intersection of all its params.
+ */
+export type NotesFilter = {
+  /**
+   * The contract address the note belongs to.
+   * @remarks Providing a contract address is required as we need that information to trigger private state sync.
+   */
+  contractAddress: AztecAddress;
+  /** The owner of the note. */
+  owner?: AztecAddress;
+  /** The specific storage location of the note on the contract. */
+  storageSlot?: Fr;
+  /** The status of the note. Defaults to 'ACTIVE'. */
+  status?: NoteStatus;
+  /** The siloed nullifier for the note. */
+  siloedNullifier?: Fr;
+  scopes: AztecAddress[];
+};

package/src/oracle_version.ts

@@ -1,11 +1,22 @@
-/// The ORACLE_VERSION constant is used to check that the oracle interface is in sync between PXE and Aztec.nr. We need
-/// to version the oracle interface to ensure that developers get a reasonable error message if they use incompatible
-/// versions of Aztec.nr and PXE. The Noir counterpart is in `noir-projects/aztec-nr/aztec/src/oracle/version.nr`.
+/// The oracle version constants are used to check that the oracle interface is in sync between PXE and Aztec.nr.
+/// We version the oracle interface as `major.minor` where:
+///   - `major` = backward-breaking changes (must match exactly between PXE and Aztec.nr)
+///   - `minor` = oracle additions (non-breaking; PXE minor >= contract minor)
 ///
-/// @dev Whenever a contract function or Noir test is run, the `utilityAssertCompatibleOracleVersion` oracle is called
-/// and if the oracle version is incompatible an error is thrown.
-export const ORACLE_VERSION = 3;
+/// The Noir counterparts are in `noir-projects/aztec-nr/aztec/src/oracle/version.nr`.
+///
+/// @dev Whenever a contract function or Noir test is run, the `aztec_misc_assertCompatibleOracleVersion` oracle is called.
+/// If the major version is incompatible, an error is thrown immediately. The minor version is recorded by the PXE and
+/// used to provide helpful error messages if a contract calls an oracle that doesn't exist. We don't throw immediately
+/// if AZTEC_NR_MINOR > PXE_MINOR because if a contract is updated to use a newer Aztec.nr dependency without actually
+/// using any of the new oracles then there is no reason to throw.
+export const ORACLE_VERSION_MAJOR = 29;
+export const ORACLE_VERSION_MINOR = 0;
 
-/// This hash is computed as by hashing the Oracle interface and it is used to detect when the Oracle interface changes,
-/// which in turn implies that you need to update the ORACLE_VERSION constant.
-export const ORACLE_INTERFACE_HASH = 'f9168ceb5a2227c148c5021ebffd4e2ca0da99885b87c5be3ee5ac0d8dd3d67c';
+/// This hash is computed from the Oracle interface and is used to detect when that interface changes. When it does,
+/// you need to either:
+/// - increment `ORACLE_VERSION_MAJOR` and reset `ORACLE_VERSION_MINOR` to zero if the change is breaking, or
+/// - increment only `ORACLE_VERSION_MINOR` if the change is additive (a new oracle was added).
+///
+/// These constants must be kept in sync between this file and `noir-projects/aztec-nr/aztec/src/oracle/version.nr`.
+export const ORACLE_INTERFACE_HASH = '157fe8fa79f0e5a25db3d61341f9bcf5b43cb68367bea497204006daa48751b6';

package/src/private_kernel/batch_planner.ts

@@ -0,0 +1,169 @@
+import type { Serializable, Tuple } from '@aztec/foundation/serialize';
+import {
+  ClaimedLengthArray,
+  PrivateAccumulatedData,
+  PrivateKernelCircuitPublicInputs,
+  PrivateValidationRequests,
+  ScopedKeyValidationRequestAndSeparator,
+  ScopedPrivateLogData,
+} from '@aztec/stdlib/kernel';
+import type { PrivateCallExecutionResult } from '@aztec/stdlib/tx';
+import { VerificationKeyData } from '@aztec/stdlib/vks';
+
+import { PrivateKernelResetPrivateInputsBuilder } from './hints/private_kernel_reset_private_inputs_builder.js';
+
+/**
+ * Decides how many apps from the top of the execution stack the next kernel iteration should
+ * absorb. The decision is made by keeping track of an app-by-app accumulator calling
+ * `PrivateKernelResetPrivateInputsBuilder.needsReset()` whether a reset would be required before
+ * taking each candidate.
+ *
+ * The K-batched kernels are mathematically equivalent to running K sequential `init`/`inner`
+ * iterations so a multi-app fit-check reduces to a sequence of single-app fit-checks against a rolling
+ * accumulator.
+ */
+export class BatchPlanner {
+  constructor(
+    private noteHashNullifierCounterMap: Map<number, number>,
+    private splitCounter: number,
+    private maxBatchSize: number,
+  ) {}
+
+  /**
+   * Returns the number of apps from the top of `stack` that the next kernel iteration should
+   * batch. Always at least 1 — the caller is expected to have run any pending resets first, so
+   * the next single app must always fit.
+   *
+   * The walk mirrors `consumeNextApp`'s stack manipulation (pop top, push reversed nested
+   * children, then DFS into them) on a copy of the stack, so the planner can look ahead past
+   * the parent's children without mutating the real prover stack.
+   */
+  decideBatchSize(currentAccumulator: PrivateKernelCircuitPublicInputs, stack: PrivateCallExecutionResult[]): number {
+    const virtualStack = [...stack];
+    let projected = currentAccumulator;
+    let chosen = 0;
+    for (let i = 0; i < this.maxBatchSize && virtualStack.length > 0; i++) {
+      const probe = new PrivateKernelResetPrivateInputsBuilder(
+        {
+          publicInputs: projected,
+          verificationKey: VerificationKeyData.empty(),
+          outputWitness: new Map(),
+          bytecode: Buffer.from([]),
+        },
+        virtualStack,
+        this.noteHashNullifierCounterMap,
+        this.splitCounter,
+      );
+      if (probe.needsReset()) {
+        break;
+      }
+      // Speculatively consume the top of the virtual stack the same way `consumeNextApp` does
+      // on the real stack: pop the candidate, push its reversed nested children so the next
+      // iteration's top is the next DFS app.
+      const candidate = virtualStack.pop()!;
+      virtualStack.push(...[...candidate.nestedExecutionResults].reverse());
+      projected = appendApp(projected, candidate);
+      chosen++;
+    }
+    return Math.max(1, chosen);
+  }
+}
+
+/**
+ * Returns a new `PrivateKernelCircuitPublicInputs` representing the accumulator after one kernel
+ * iteration has absorbed `app`. Mirrors the kernel composer's accumulator-update step
+ * (`PrivateKernelCircuitOutputComposer::scope_and_propagate_from_private_call`) for the six
+ * fields that `PrivateKernelResetPrivateInputsBuilder.needsReset()` inspects:
+ *
+ * - `validationRequests.noteHashReadRequests`              (already scoped per app; appended as-is)
+ * - `validationRequests.nullifierReadRequests`             (already scoped per app; appended as-is)
+ * - `validationRequests.scopedKeyValidationRequestsAndSeparators` (scope with call's contract address)
+ * - `end.noteHashes`                                       (scope)
+ * - `end.nullifiers`                                       (scope)
+ * - `end.privateLogs`                                      (scope)
+ *
+ * Other fields on `PrivateKernelCircuitPublicInputs` (constants, fee_payer, expiration_timestamp,
+ * public_call_requests, l2_to_l1_msgs, contract_class_logs_hashes, etc.) are not read by
+ * `needsReset()` and are carried over unchanged from `acc`.
+ */
+export function appendApp(
+  acc: PrivateKernelCircuitPublicInputs,
+  app: PrivateCallExecutionResult,
+): PrivateKernelCircuitPublicInputs {
+  const ca = app.publicInputs.callContext.contractAddress;
+  const appPi = app.publicInputs;
+
+  const newNoteHashReadRequests = cloneClaimedLengthArray(acc.validationRequests.noteHashReadRequests);
+  pushAll(newNoteHashReadRequests, appPi.noteHashReadRequests.getActiveItems());
+
+  const newNullifierReadRequests = cloneClaimedLengthArray(acc.validationRequests.nullifierReadRequests);
+  pushAll(newNullifierReadRequests, appPi.nullifierReadRequests.getActiveItems());
+
+  const newScopedKvrs = cloneClaimedLengthArray(acc.validationRequests.scopedKeyValidationRequestsAndSeparators);
+  pushAll(
+    newScopedKvrs,
+    appPi.keyValidationRequestsAndSeparators
+      .getActiveItems()
+      .map(kvr => new ScopedKeyValidationRequestAndSeparator(kvr, ca)),
+  );
+
+  const newNoteHashes = cloneClaimedLengthArray(acc.end.noteHashes);
+  pushAll(
+    newNoteHashes,
+    appPi.noteHashes.getActiveItems().map(nh => nh.scope(ca)),
+  );
+
+  const newNullifiers = cloneClaimedLengthArray(acc.end.nullifiers);
+  pushAll(
+    newNullifiers,
+    appPi.nullifiers.getActiveItems().map(n => n.scope(ca)),
+  );
+
+  const newPrivateLogs = cloneClaimedLengthArray(acc.end.privateLogs);
+  pushAll(
+    newPrivateLogs,
+    appPi.privateLogs.getActiveItems().map(pl => new ScopedPrivateLogData(pl, ca)),
+  );
+
+  const validationRequests = new PrivateValidationRequests(
+    newNoteHashReadRequests,
+    newNullifierReadRequests,
+    newScopedKvrs,
+  );
+
+  const end = new PrivateAccumulatedData(
+    newNoteHashes,
+    newNullifiers,
+    acc.end.l2ToL1Msgs,
+    newPrivateLogs,
+    acc.end.contractClassLogsHashes,
+    acc.end.publicCallRequests,
+    acc.end.privateCallStack,
+  );
+
+  return new PrivateKernelCircuitPublicInputs(
+    acc.constants,
+    acc.minRevertibleSideEffectCounter,
+    validationRequests,
+    end,
+    acc.publicTeardownCallRequest,
+    acc.feePayer,
+    acc.expirationTimestamp,
+    acc.isPrivateOnly,
+    acc.claimedFirstNullifier,
+    acc.claimedRevertibleCounter,
+  );
+}
+
+function cloneClaimedLengthArray<T extends Serializable, N extends number>(
+  src: ClaimedLengthArray<T, N>,
+): ClaimedLengthArray<T, N> {
+  return new ClaimedLengthArray([...src.array] as Tuple<T, N>, src.claimedLength);
+}
+
+function pushAll<T extends Serializable, N extends number>(arr: ClaimedLengthArray<T, N>, items: T[]) {
+  for (const item of items) {
+    arr.array[arr.claimedLength] = item;
+    arr.claimedLength++;
+  }
+}

package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts}

@@ -1,4 +1,4 @@
-import { MAX_INCLUDE_BY_TIMESTAMP_DURATION } from '@aztec/constants';
+import { MAX_TX_LIFETIME } from '@aztec/constants';
 import type { PrivateKernelCircuitPublicInputs } from '@aztec/stdlib/kernel';
 import type { UInt64 } from '@aztec/stdlib/types';
 
@@ -8,12 +8,12 @@ const ROUNDED_DURATIONS = [
   1, // 1 second
 ];
 
-function roundTimestamp(blockTimestamp: bigint, includeByTimestamp: bigint): UInt64 {
+function roundTimestamp(blockTimestamp: bigint, expirationTimestamp: bigint): UInt64 {
   return ROUNDED_DURATIONS.reduce((timestamp, duration) => {
     if (timestamp <= blockTimestamp) {
       // The timestamp must be greater than the block timestamp.
       // If it is too small, round it down again using a smaller duration.
-      const totalDuration = includeByTimestamp - blockTimestamp;
+      const totalDuration = expirationTimestamp - blockTimestamp;
       const roundedDuration = totalDuration - (totalDuration % BigInt(duration));
       return blockTimestamp + roundedDuration;
     }
@@ -21,36 +21,36 @@ function roundTimestamp(blockTimestamp: bigint, includeByTimestamp: bigint): UIn
   }, 0n);
 }
 
-export function computeTxIncludeByTimestamp(
+export function computeTxExpirationTimestamp(
   previousKernel: PrivateKernelCircuitPublicInputs,
-  maxDuration = MAX_INCLUDE_BY_TIMESTAMP_DURATION,
+  txLifetime = MAX_TX_LIFETIME,
 ): UInt64 {
-  if (maxDuration > MAX_INCLUDE_BY_TIMESTAMP_DURATION) {
+  if (txLifetime > MAX_TX_LIFETIME) {
     throw new Error(
-      `Custom max duration cannot be greater than the max allowed. Max allowed: ${MAX_INCLUDE_BY_TIMESTAMP_DURATION}. Custom value: ${maxDuration}.`,
+      `Custom tx lifetime cannot be greater than the max allowed. Max allowed: ${MAX_TX_LIFETIME}. Custom value: ${txLifetime}.`,
     );
   }
 
   const anchorBlockTimestamp = previousKernel.constants.anchorBlockHeader.globalVariables.timestamp;
-  const maxTimestamp = anchorBlockTimestamp + BigInt(maxDuration);
-  const includeByTimestamp = previousKernel.includeByTimestamp;
+  const maxTimestamp = anchorBlockTimestamp + BigInt(txLifetime);
+  const expirationTimestamp = previousKernel.expirationTimestamp;
 
-  // If the includeByTimestamp set during the tx execution is greater than or equal to the max allowed duration,
+  // If the expirationTimestamp set during the tx execution is greater than or equal to the max allowed duration,
   // use the maximum allowed timestamp.
   // Note: It shouldn't be larger than the max allowed duration, but we check for it anyway.
-  if (includeByTimestamp >= maxTimestamp) {
+  if (expirationTimestamp >= maxTimestamp) {
     return maxTimestamp;
   }
 
   // Round it down to the nearest hour/min/second to reduce precision and avoid revealing the exact value.
   // This makes it harder for others to infer what function calls may have been used to produce a specific timestamp.
-  const roundedTimestamp = roundTimestamp(anchorBlockTimestamp, includeByTimestamp);
+  const roundedTimestamp = roundTimestamp(anchorBlockTimestamp, expirationTimestamp);
 
   // The tx can't be published if the timestamp is the same or less than the anchor block's timestamp.
   // Future blocks will have a greater timestamp, so the tx would never be included.
   if (roundedTimestamp <= anchorBlockTimestamp) {
     throw new Error(
-      `Include-by timestamp must be greater than the anchor block timestamp. Anchor block timestamp: ${anchorBlockTimestamp}. Include-by timestamp: ${includeByTimestamp}.`,
+      `Include-by timestamp must be greater than the anchor block timestamp. Anchor block timestamp: ${anchorBlockTimestamp}. Include-by timestamp: ${expirationTimestamp}.`,
     );
   }
 

package/src/private_kernel/hints/index.ts

@@ -1,2 +1,2 @@
-export * from './build_private_kernel_reset_private_inputs.js';
-export * from './compute_tx_include_by_timestamp.js';
+export * from './private_kernel_reset_private_inputs_builder.js';
+export * from './compute_tx_expiration_timestamp.js';