@aztec/pxe 0.0.1-commit.7b97ef96e → 0.0.1-commit.7cbc774

package/src/notes_filter.ts

@@ -2,8 +2,6 @@ import type { Fr } from '@aztec/foundation/curves/bn254';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { NoteStatus } from '@aztec/stdlib/note';
 
-import type { AccessScopes } from './access_scopes.js';
-
 /**
  * A filter used to fetch notes.
  * @remarks This filter is applied as an intersection of all its params.
@@ -22,5 +20,5 @@ export type NotesFilter = {
   status?: NoteStatus;
   /** The siloed nullifier for the note. */
   siloedNullifier?: Fr;
-  scopes: AccessScopes;
+  scopes: AztecAddress[];
 };

package/src/oracle_version.ts

@@ -1,12 +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 = 12;
+/// 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_utl_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 = 27;
+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 in this file and in
-/// `noir-projects/aztec-nr/aztec/src/oracle/version.nr`.
-export const ORACLE_INTERFACE_HASH = '666a8a7fc697f72b29dbf0ae7464db269cf5afa019acac8861f814543147dbb4';
+/// 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 = '43383f5a2cf9b39908e86a3d733862b08d307c08fa58db681f8b08804042e550';

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++;
+  }
+}