@aztec/pxe 0.0.1-commit.2448fdb → 0.0.1-commit.2606882

package/src/notes/note_service.ts

@@ -1,12 +1,14 @@
+import { chunk } from '@aztec/foundation/collection';
 import { Fr } from '@aztec/foundation/curves/bn254';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { DataInBlock } from '@aztec/stdlib/block';
+import { BlockHash, type DataInBlock } from '@aztec/stdlib/block';
 import { computeUniqueNoteHash, siloNoteHash, siloNullifier } from '@aztec/stdlib/hash';
 import { type AztecNode, MAX_RPC_LEN } from '@aztec/stdlib/interfaces/client';
 import { Note, NoteDao, NoteStatus } from '@aztec/stdlib/note';
 import { MerkleTreeId } from '@aztec/stdlib/trees';
-import type { BlockHeader, TxHash } from '@aztec/stdlib/tx';
+import type { BlockHeader, IndexedTxEffect } from '@aztec/stdlib/tx';
 
+import type { NoteValidationRequest } from '../contract_function_simulator/noir-structs/note_validation_request.js';
 import type { NoteStore } from '../storage/note_store/note_store.js';
 
 export class NoteService {
@@ -80,24 +82,7 @@ export class NoteService {
     }
 
     const nullifiersToCheck = contractNotes.map(note => note.siloedNullifier);
-    const nullifierBatches = nullifiersToCheck.reduce(
-      (acc, nullifier) => {
-        if (acc[acc.length - 1].length < MAX_RPC_LEN) {
-          acc[acc.length - 1].push(nullifier);
-        } else {
-          acc.push([nullifier]);
-        }
-        return acc;
-      },
-      [[]] as Fr[][],
-    );
-    const nullifierIndexes = (
-      await Promise.all(
-        nullifierBatches.map(batch =>
-          this.aztecNode.findLeavesIndexes(anchorBlockHash, MerkleTreeId.NULLIFIER_TREE, batch),
-        ),
-      )
-    ).flat();
+    const nullifierIndexes = await this.#findNullifierIndexes(anchorBlockHash, nullifiersToCheck);
 
     const foundNullifiers = nullifiersToCheck
       .map((nullifier, i) => {
@@ -110,30 +95,34 @@ export class NoteService {
     await this.noteStore.applyNullifiers(foundNullifiers, this.jobId);
   }
 
-  public async validateAndStoreNote(
-    contractAddress: AztecAddress,
-    owner: AztecAddress,
-    storageSlot: Fr,
-    randomness: Fr,
-    noteNonce: Fr,
-    content: Fr[],
-    noteHash: Fr,
-    nullifier: Fr,
-    txHash: TxHash,
+  /**
+   * Validates and stores a batch of notes against pre-fetched tx effects.
+   *
+   * For each request we must verify that:
+   *  - the note actually exists in the corresponding tx effect (and thus in the note hash tree), and
+   *  - the note has not already been nullified.
+   *
+   * Failing to do either would result in circuits getting either non-existent notes and failing to produce inclusion
+   * proofs for them, or getting nullified notes and producing duplicate nullifiers, both of which are catastrophic
+   * failure modes.
+   *
+   * Note that adding a note and removing it is *not* equivalent to never adding it in the first place. A nullifier
+   * emitted in a block that comes after note creation might result in the note being de-nullified by a chain reorg,
+   * so we must store both the note hash and nullifier block information.
+   *
+   * @param requests - The notes to validate and store.
+   * @param scope - The scope under which the notes are being stored.
+   * @param txEffects - Pre-fetched tx effects keyed by `TxHash.toString()`. Must contain entries for every request's
+   *                   txHash; missing entries are treated as a node bug and cause an error.
+   */
+  public async validateAndStoreNotes(
+    requests: NoteValidationRequest[],
     scope: AztecAddress,
+    txEffects: Map<string, IndexedTxEffect>,
   ): Promise<void> {
-    // We are going to store the new note in the NoteStore, which will let us later return it via `getNotes`.
-    // There's two things we need to check before we do this however:
-    //  - we must make sure the note does actually exist in the note hash tree
-    //  - we need to check if the note has already been nullified
-    //
-    // Failing to do either of the above would result in circuits getting either non-existent notes and failing to
-    // produce inclusion proofs for them, or getting nullified notes and producing duplicate nullifiers, both of which
-    // are catastrophic failure modes.
-    //
-    // Note that adding a note and removing it is *not* equivalent to never adding it in the first place. A nullifier
-    // emitted in a block that comes after note creation might result in the note being de-nullified by a chain reorg,
-    // so we must store both the note hash and nullifier block information.
+    if (requests.length === 0) {
+      return;
+    }
 
     // We avoid making node queries at 'latest' since we don't want to process notes or nullifiers that only exist ahead
     // in time of the locally synced state.
@@ -146,61 +135,96 @@ export class NoteService {
 
     // By computing siloed and unique note hashes ourselves we prevent contracts from interfering with the note storage
     // of other contracts, which would constitute a security breach.
-    const uniqueNoteHash = await computeUniqueNoteHash(noteNonce, await siloNoteHash(contractAddress, noteHash));
-    const siloedNullifier = await siloNullifier(contractAddress, nullifier);
-
-    const [txEffect, [nullifierIndex]] = await Promise.all([
-      this.aztecNode.getTxEffect(txHash),
-      this.aztecNode.findLeavesIndexes(anchorBlockHash, MerkleTreeId.NULLIFIER_TREE, [siloedNullifier]),
-    ]);
-    if (!txEffect) {
-      // We error out instead of just logging a warning and skipping the note because this would indicate a bug. This
-      // is because the node has already served info about this tx either when obtaining the log (TxScopedL2Log contain
-      // tx info) or when getting metadata for the offchain message (before the message got passed to `process_log`).
-      throw new Error(`Could not find tx effect for tx hash ${txHash} when processing a note.`);
-    }
+    const computed = await Promise.all(
+      requests.map(async ({ contractAddress, noteHash, nullifier, noteNonce }) => {
+        const [siloedNoteHash, siloedNullifier] = await Promise.all([
+          siloNoteHash(contractAddress, noteHash),
+          siloNullifier(contractAddress, nullifier),
+        ]);
+        const uniqueNoteHash = await computeUniqueNoteHash(noteNonce, siloedNoteHash);
+        return { uniqueNoteHash, siloedNullifier };
+      }),
+    );
 
-    if (txEffect.l2BlockNumber > anchorBlockNumber) {
-      // If the message was delivered onchain, this would indicate a bug: log sync should never load logs from blocks
-      // newer than the anchor block. If the note came via an offchain message, it would likely also be a bug, since we
-      // sync a new anchor block before calling `process_message`. For this not to be a bug, the message would need to
-      // come from a newer block than the anchor served by the node, implying the node isn't properly synced.
-      //     We therefore error out here rather than assuming the offchain message was constructed by a malicious
-      // sender with the intention of bricking recipient's PXE (if we assumed that we would just ignore the message).
-      throw new Error(
-        `Obtained a newer tx effect for ${txHash} for a note validation request than the anchor block ${anchorBlockNumber}. This is a bug as we should not ever be processing a note from a newer block than the anchor block.`,
+    const nullifierIndexes = await this.#findNullifierIndexes(
+      anchorBlockHash,
+      computed.map(c => c.siloedNullifier),
+    );
+
+    const noteDaos: NoteDao[] = [];
+    const foundNullifiers: DataInBlock<Fr>[] = [];
+
+    for (let i = 0; i < requests.length; i++) {
+      const { contractAddress, owner, storageSlot, randomness, noteNonce, content, noteHash, txHash } = requests[i];
+      const { uniqueNoteHash, siloedNullifier } = computed[i];
+      const nullifierIndex = nullifierIndexes[i];
+
+      const txEffect = txEffects.get(txHash.toString());
+      if (!txEffect) {
+        // We error out instead of just logging a warning and skipping the note because this would indicate a bug. This
+        // is because the node has already served info about this tx either when obtaining the log (LogResult carries
+        // the tx info) or when getting metadata for the offchain message (before the message got passed to
+        // `process_log`).
+        throw new Error(`Could not find tx effect for tx hash ${txHash} when processing a note.`);
+      }
+
+      if (txEffect.l2BlockNumber > anchorBlockNumber) {
+        // If the message was delivered onchain, this would indicate a bug: log sync should never load logs from blocks
+        // newer than the anchor block. If the note came via an offchain message, it would likely also be a bug, since
+        // we sync a new anchor block before calling `process_message`. For this not to be a bug, the message would
+        // need to come from a newer block than the anchor served by the node, implying the node isn't properly synced.
+        //     We therefore error out here rather than assuming the offchain message was constructed by a malicious
+        // sender with the intention of bricking recipient's PXE (if we assumed that we would just ignore the message).
+        throw new Error(
+          `Obtained a newer tx effect for ${txHash} for a note validation request than the anchor block ${anchorBlockNumber}. This is a bug as we should not ever be processing a note from a newer block than the anchor block.`,
+        );
+      }
+
+      // Find the index of the note hash in the noteHashes array to determine note ordering within the tx
+      const noteIndexInTx = txEffect.data.noteHashes.findIndex(nh => nh.equals(uniqueNoteHash));
+      if (noteIndexInTx === -1) {
+        // Similar to the comment above - we error out as this would indicate a bug in nonce discovery.
+        throw new Error(`Note hash ${noteHash} (uniqued as ${uniqueNoteHash}) is not present in tx ${txHash}`);
+      }
+
+      noteDaos.push(
+        new NoteDao(
+          new Note(content),
+          contractAddress,
+          owner,
+          storageSlot,
+          randomness,
+          noteNonce,
+          noteHash,
+          siloedNullifier,
+          txHash,
+          txEffect.l2BlockNumber,
+          txEffect.l2BlockHash.toString(),
+          txEffect.txIndexInBlock,
+          noteIndexInTx,
+        ),
       );
-    }
 
-    // Find the index of the note hash in the noteHashes array to determine note ordering within the tx
-    const noteIndexInTx = txEffect.data.noteHashes.findIndex(nh => nh.equals(uniqueNoteHash));
-    if (noteIndexInTx === -1) {
-      // Similar to the comment above - we error out as this would indicate a bug in nonce discovery.
-      throw new Error(`Note hash ${noteHash} (uniqued as ${uniqueNoteHash}) is not present in tx ${txHash}`);
+      if (nullifierIndex !== undefined) {
+        // We found a nullifier index which implies that the note has already been nullified.
+        const { data: _, ...blockHashAndNum } = nullifierIndex;
+        foundNullifiers.push({ data: siloedNullifier, ...blockHashAndNum });
+      }
     }
 
-    const noteDao = new NoteDao(
-      new Note(content),
-      contractAddress,
-      owner,
-      storageSlot,
-      randomness,
-      noteNonce,
-      noteHash,
-      siloedNullifier,
-      txHash,
-      txEffect.l2BlockNumber,
-      txEffect.l2BlockHash.toString(),
-      txEffect.txIndexInBlock,
-      noteIndexInTx,
-    );
-
-    await this.noteStore.addNotes([noteDao], scope, this.jobId);
+    await this.noteStore.addNotes(noteDaos, scope, this.jobId);
 
-    if (nullifierIndex !== undefined) {
-      // We found nullifier index which implies that the note has already been nullified.
-      const { data: _, ...blockHashAndNum } = nullifierIndex;
-      await this.noteStore.applyNullifiers([{ data: siloedNullifier, ...blockHashAndNum }], this.jobId);
+    if (foundNullifiers.length > 0) {
+      await this.noteStore.applyNullifiers(foundNullifiers, this.jobId);
     }
   }
+
+  async #findNullifierIndexes(anchorBlockHash: BlockHash, siloedNullifiers: Fr[]) {
+    const batches = chunk(siloedNullifiers, MAX_RPC_LEN);
+    return (
+      await Promise.all(
+        batches.map(batch => this.aztecNode.findLeavesIndexes(anchorBlockHash, MerkleTreeId.NULLIFIER_TREE, batch)),
+      )
+    ).flat();
+  }
 }

package/src/oracle_version.ts

@@ -5,13 +5,13 @@
 ///
 /// 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.
+/// @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 = 22;
-export const ORACLE_VERSION_MINOR = 1;
+export const ORACLE_VERSION_MAJOR = 29;
+export const ORACLE_VERSION_MINOR = 0;
 
 /// This hash is computed from the Oracle interface and is used to detect when that interface changes. When it does,
 /// you need to either:
@@ -19,4 +19,4 @@ export const ORACLE_VERSION_MINOR = 1;
 /// - 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 = 'efafa0db2cc1f94e26d794d0079c8f71115261df0c3d0fa8cb5b64f17a12db92';
+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/private_kernel_reset_private_inputs_builder.ts

@@ -68,7 +68,7 @@ async function getMasterSecretKeysAndKeyTypeDomainSeparators(
   const numRequestsToProcess = Math.min(keyValidationRequests.claimedLength, numRequestsToVerify);
   const keysHints = await Promise.all(
     keyValidationRequests.array.slice(0, numRequestsToProcess).map(async ({ request }) => {
-      const secretKeys = await oracle.getMasterSecretKey(request.request.pkM);
+      const secretKeys = await oracle.getMasterSecretKey(request.request.pkMHash);
       return new KeyValidationHint(secretKeys);
     }),
   );

package/src/private_kernel/hints/test_utils.ts

@@ -14,7 +14,6 @@ import {
 } from '@aztec/constants';
 import { makeTuple } from '@aztec/foundation/array';
 import { Fr } from '@aztec/foundation/curves/bn254';
-import { Point } from '@aztec/foundation/curves/grumpkin';
 import type { Serializable } from '@aztec/foundation/serialize';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import {
@@ -130,10 +129,7 @@ export class PrivateKernelCircuitPublicInputsBuilder {
     const addr = opts?.contractAddress ?? this.contractAddress;
     this.keyValidationRequests.push(
       new ScopedKeyValidationRequestAndSeparator(
-        new KeyValidationRequestAndSeparator(
-          new KeyValidationRequest(new Point(Fr.random(), Fr.random(), false), Fr.random()),
-          Fr.random(),
-        ),
+        new KeyValidationRequestAndSeparator(new KeyValidationRequest(Fr.random(), Fr.random()), Fr.random()),
         addr,
       ),
     );
@@ -253,10 +249,7 @@ export class PrivateCircuitPublicInputsBuilder {
   /** Adds a key validation request. */
   addKeyValidationRequest(): this {
     this.keyValidationRequests.push(
-      new KeyValidationRequestAndSeparator(
-        new KeyValidationRequest(new Point(Fr.random(), Fr.random(), false), Fr.random()),
-        Fr.random(),
-      ),
+      new KeyValidationRequestAndSeparator(new KeyValidationRequest(Fr.random(), Fr.random()), Fr.random()),
     );
     return this;
   }