refactor: renaming IndexedTaggingSecret as PreTag (#17568)

Renamed `IndexedTaggingSecret` as `PreTag` as the original name was
confusing. See [this
conversation](#17445 (comment))
for more context.

Author: benesjan

yarn-project/pxe/src/contract_function_simulator/execution_tagging_index_cache.ts

@@ -1,4 +1,4 @@
-import { DirectionalAppTaggingSecret, type IndexedTaggingSecret } from '@aztec/stdlib/logs';
+import { DirectionalAppTaggingSecret, type PreTag } from '@aztec/stdlib/logs';
 
 /**
  * A map that stores the tagging index for a given directional app tagging secret.
@@ -21,9 +21,9 @@ export class ExecutionTaggingIndexCache {
   }
 
   /**
-   * Returns the indexed tagging secrets that were used in this execution.
+   * Returns the pre tags that were used in this execution (and that need to be stored in the db).
    */
-  public getUsedIndexedTaggingSecrets(): IndexedTaggingSecret[] {
+  public getUsedPreTags(): PreTag[] {
     return Array.from(this.taggingIndexMap.entries()).map(([secret, index]) => ({
       secret: DirectionalAppTaggingSecret.fromString(secret),
       index,

yarn-project/pxe/src/contract_function_simulator/oracle/private_execution.ts

@@ -88,7 +88,7 @@ export async function executePrivateFunction(
   const newNotes = privateExecutionOracle.getNewNotes();
   const noteHashNullifierCounterMap = privateExecutionOracle.getNoteHashNullifierCounterMap();
   const offchainEffects = privateExecutionOracle.getOffchainEffects();
-  const indexedTaggingSecrets = privateExecutionOracle.getUsedIndexedTaggingSecrets();
+  const preTags = privateExecutionOracle.getUsedPreTags();
   const nestedExecutionResults = privateExecutionOracle.getNestedExecutionResults();
 
   let timerSubtractionList = nestedExecutionResults;
@@ -112,7 +112,7 @@ export async function executePrivateFunction(
     noteHashNullifierCounterMap,
     rawReturnValues,
     offchainEffects,
-    indexedTaggingSecrets,
+    preTags,
     nestedExecutionResults,
     contractClassLogs,
     {

yarn-project/pxe/src/contract_function_simulator/oracle/private_execution_oracle.ts

@@ -14,7 +14,7 @@ import type { AuthWitness } from '@aztec/stdlib/auth-witness';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { computeUniqueNoteHash, siloNoteHash, siloNullifier } from '@aztec/stdlib/hash';
 import { PrivateContextInputs } from '@aztec/stdlib/kernel';
-import type { ContractClassLog, DirectionalAppTaggingSecret, IndexedTaggingSecret } from '@aztec/stdlib/logs';
+import type { ContractClassLog, DirectionalAppTaggingSecret, PreTag } from '@aztec/stdlib/logs';
 import { Note, type NoteStatus } from '@aztec/stdlib/note';
 import {
   type BlockHeader,
@@ -152,10 +152,10 @@ export class PrivateExecutionOracle extends UtilityExecutionOracle implements IP
   }
 
   /**
-   * Returns the indexed tagging secrets that were used in this execution.
+   * Returns the pre tags that were used in this execution (and that need to be stored in the db).
    */
-  public getUsedIndexedTaggingSecrets(): IndexedTaggingSecret[] {
-    return this.taggingIndexCache.getUsedIndexedTaggingSecrets();
+  public getUsedPreTags(): PreTag[] {
+    return this.taggingIndexCache.getUsedPreTags();
   }
 
   /**

yarn-project/pxe/src/contract_function_simulator/pxe_oracle_interface.ts

@@ -46,8 +46,8 @@ import {
   SiloedTag,
   Tag,
   WINDOW_HALF_SIZE,
-  getIndexedTaggingSecretsForTheWindow,
   getInitialIndexesMap,
+  getPreTagsForTheWindow,
 } from '../tagging/index.js';
 import { EventValidationRequest } from './noir-structs/event_validation_request.js';
 import { LogRetrievalRequest } from './noir-structs/log_retrieval_request.js';
@@ -289,15 +289,19 @@ export class PXEOracleInterface implements ExecutionDataProvider {
   }
 
   /**
-   * Returns the indexed tagging secrets for a given recipient and all the senders in the address book
+   * Returns the last used tagging indexes along with the directional app tagging secrets for a given recipient and all
+   * the senders in the address book.
    * This method should be exposed as an oracle call to allow aztec.nr to perform the orchestration
    * of the syncTaggedLogs and processTaggedLogs methods. However, it is not possible to do so at the moment,
    * so we're keeping it private for now.
    * @param contractAddress - The contract address to silo the secret for
    * @param recipient - The address receiving the notes
-   * @returns A list of indexed tagging secrets. If the corresponding secret was never used, the index is undefined.
+   * @returns A list of directional app tagging secrets along with the last used tagging indexes. If the corresponding
+   * secret was never used, the index is undefined.
+   * TODO(benesjan): The naming here is broken as the function name does not reflect the return type. Fix when associating
+   * indexes with tx hash.
    */
-  async #getLastUsedIndexedTaggingSecretsForSenders(
+  async #getLastUsedTaggingIndexesForSenders(
     contractAddress: AztecAddress,
     recipient: AztecAddress,
   ): Promise<{ secret: DirectionalAppTaggingSecret; index: number | undefined }[]> {
@@ -425,7 +429,7 @@ export class PXEOracleInterface implements ExecutionDataProvider {
     const contractName = await this.contractDataProvider.getDebugContractName(contractAddress);
     for (const recipient of recipients) {
       // Get all the secrets for the recipient and sender pairs (#9365)
-      const indexedSecrets = await this.#getLastUsedIndexedTaggingSecretsForSenders(contractAddress, recipient);
+      const indexedSecrets = await this.#getLastUsedTaggingIndexesForSenders(contractAddress, recipient);
 
       // We fetch logs for a window of indexes in a range:
       //    <latest_log_index - WINDOW_HALF_SIZE, latest_log_index + WINDOW_HALF_SIZE>.
@@ -459,10 +463,10 @@ export class PXEOracleInterface implements ExecutionDataProvider {
       const initialIndexesMap = getInitialIndexesMap(indexedSecrets);
 
       while (secretsAndWindows.length > 0) {
-        const secretsForTheWholeWindow = getIndexedTaggingSecretsForTheWindow(secretsAndWindows);
+        const preTagsForTheWholeWindow = getPreTagsForTheWindow(secretsAndWindows);
         const tagsForTheWholeWindow = await Promise.all(
-          secretsForTheWholeWindow.map(async indexedSecret => {
-            return SiloedTag.compute(await Tag.compute(indexedSecret), contractAddress);
+          preTagsForTheWholeWindow.map(async preTag => {
+            return SiloedTag.compute(await Tag.compute(preTag), contractAddress);
           }),
         );
 
@@ -495,25 +499,25 @@ export class PXEOracleInterface implements ExecutionDataProvider {
               filteredLogsByBlockNumber,
             );
 
-            // We retrieve the indexed tagging secret corresponding to the log as I need that to evaluate whether
+            // We retrieve the pre tag corresponding to the log as I need that to evaluate whether
             // a new largest index have been found.
-            const secretCorrespondingToLog = secretsForTheWholeWindow[logIndex];
-            const initialIndex = initialIndexesMap[secretCorrespondingToLog.secret.toString()];
+            const preTagCorrespondingToLog = preTagsForTheWholeWindow[logIndex];
+            const initialIndex = initialIndexesMap[preTagCorrespondingToLog.secret.toString()];
 
             if (
-              secretCorrespondingToLog.index >= initialIndex &&
-              (newLargestIndexMapForIteration[secretCorrespondingToLog.secret.toString()] === undefined ||
-                secretCorrespondingToLog.index >=
-                  newLargestIndexMapForIteration[secretCorrespondingToLog.secret.toString()])
+              preTagCorrespondingToLog.index >= initialIndex &&
+              (newLargestIndexMapForIteration[preTagCorrespondingToLog.secret.toString()] === undefined ||
+                preTagCorrespondingToLog.index >=
+                  newLargestIndexMapForIteration[preTagCorrespondingToLog.secret.toString()])
             ) {
               // We have found a new largest index so we store it for later processing (storing it in the db + fetching
               // the difference of the window sets of current and the next iteration)
-              newLargestIndexMapForIteration[secretCorrespondingToLog.secret.toString()] =
-                secretCorrespondingToLog.index + 1;
+              newLargestIndexMapForIteration[preTagCorrespondingToLog.secret.toString()] =
+                preTagCorrespondingToLog.index + 1;
 
               this.log.debug(
                 `Incrementing index to ${
-                  secretCorrespondingToLog.index + 1
+                  preTagCorrespondingToLog.index + 1
                 } at contract ${contractName}(${contractAddress})`,
               );
             }

yarn-project/pxe/src/pxe.ts

@@ -743,14 +743,14 @@ export class PXE {
           nodeRPCCalls: contractFunctionSimulator?.getStats().nodeRPCCalls,
         });
 
-        const indexedTaggingSecretsIncrementedInTheTx = privateExecutionResult.entrypoint.indexedTaggingSecrets;
-        if (indexedTaggingSecretsIncrementedInTheTx.length > 0) {
-          await this.taggingDataProvider.setLastUsedIndexesAsSender(indexedTaggingSecretsIncrementedInTheTx);
-          this.log.debug(`Stored last used tagging secret indexes as sender for the tx`, {
-            indexedTaggingSecretsIncrementedInTheTx,
+        const preTagsUsedInTheTx = privateExecutionResult.entrypoint.preTags;
+        if (preTagsUsedInTheTx.length > 0) {
+          await this.taggingDataProvider.setLastUsedIndexesAsSender(preTagsUsedInTheTx);
+          this.log.debug(`Stored used pre tags as sender for the tx`, {
+            preTagsUsedInTheTx,
           });
         } else {
-          this.log.debug(`No tagging secret indexes incremented in the tx`);
+          this.log.debug(`No pre tags used in the tx`);
         }
 
         return txProvingResult;

yarn-project/pxe/src/storage/tagging_data_provider/tagging_data_provider.ts

@@ -1,7 +1,7 @@
 import { toArray } from '@aztec/foundation/iterable';
 import type { AztecAsyncKVStore, AztecAsyncMap } from '@aztec/kv-store';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { DirectionalAppTaggingSecret, IndexedTaggingSecret } from '@aztec/stdlib/logs';
+import type { DirectionalAppTaggingSecret, PreTag } from '@aztec/stdlib/logs';
 
 export class TaggingDataProvider {
   #store: AztecAsyncKVStore;
@@ -23,34 +23,37 @@ export class TaggingDataProvider {
 
   /**
    * Sets the last used indexes when sending a log.
-   * @param indexedSecrets - The indexed secrets to set the last used indexes for.
-   * @throws If there are duplicate secrets in the input array
+   * @param preTags - The pre tags containing the directional app tagging secrets and the indexes that are to be
+   * updated in the db.
+   * @throws If any two pre tags contain the same directional app tagging secret
    */
-  setLastUsedIndexesAsSender(indexedSecrets: IndexedTaggingSecret[]) {
-    this.#assertUniqueSecrets(indexedSecrets, 'sender');
+  setLastUsedIndexesAsSender(preTags: PreTag[]) {
+    this.#assertUniqueSecrets(preTags, 'sender');
 
     return Promise.all(
-      indexedSecrets.map(({ secret, index }) => this.#lastUsedIndexesAsSenders.set(secret.toString(), index)),
+      preTags.map(({ secret, index }) => this.#lastUsedIndexesAsSenders.set(secret.toString(), index)),
     );
   }
 
   /**
    * Sets the last used indexes when looking for logs.
-   * @param indexedSecrets - The indexed secrets to set the last used indexes for.
-   * @throws If there are duplicate secrets in the input array
+   * @param preTags - The pre tags containing the directional app tagging secrets and the indexes that are to be
+   * updated in the db.
+   * @throws If any two pre tags contain the same directional app tagging secret
    */
-  setLastUsedIndexesAsRecipient(indexedSecrets: IndexedTaggingSecret[]) {
-    this.#assertUniqueSecrets(indexedSecrets, 'recipient');
+  setLastUsedIndexesAsRecipient(preTags: PreTag[]) {
+    this.#assertUniqueSecrets(preTags, 'recipient');
 
     return Promise.all(
-      indexedSecrets.map(({ secret, index }) => this.#lastUsedIndexesAsRecipients.set(secret.toString(), index)),
+      preTags.map(({ secret, index }) => this.#lastUsedIndexesAsRecipients.set(secret.toString(), index)),
     );
   }
 
-  // It should never happen that we would receive a duplicate secrets on the input of the setters as everywhere
-  // we always just apply the largest index. Hence this check is a good way to catch bugs.
-  #assertUniqueSecrets(indexedSecrets: IndexedTaggingSecret[], role: 'sender' | 'recipient'): void {
-    const secretStrings = indexedSecrets.map(({ secret }) => secret.toString());
+  // It should never happen that we would receive any two pre tags on the input containing the same directional app
+  // tagging secret as everywhere we always just apply the largest index. Hence this check is a good way to catch
+  // bugs.
+  #assertUniqueSecrets(preTags: PreTag[], role: 'sender' | 'recipient'): void {
+    const secretStrings = preTags.map(({ secret }) => secret.toString());
     const uniqueSecrets = new Set(secretStrings);
     if (uniqueSecrets.size !== secretStrings.length) {
       throw new Error(`Duplicate secrets found when setting last used indexes as ${role}`);

yarn-project/pxe/src/tagging/constants.ts

@@ -1,2 +1,2 @@
-// Half the size of the window we slide over the tagging secret indexes.
+// Half the size of the window we slide over the tagging indexes.
 export const WINDOW_HALF_SIZE = 10;

yarn-project/pxe/src/tagging/index.ts

@@ -3,4 +3,4 @@ export * from './constants.js';
 export * from './siloed_tag.js';
 export * from './utils.js';
 export { DirectionalAppTaggingSecret } from '@aztec/stdlib/logs';
-export { type IndexedTaggingSecret } from '@aztec/stdlib/logs';
+export { type PreTag } from '@aztec/stdlib/logs';

yarn-project/pxe/src/tagging/tag.ts

@@ -1,6 +1,6 @@
 import { poseidon2Hash } from '@aztec/foundation/crypto';
 import type { Fr } from '@aztec/foundation/fields';
-import type { IndexedTaggingSecret } from '@aztec/stdlib/logs';
+import type { PreTag } from '@aztec/stdlib/logs';
 
 /**
  * Represents a tag of a private log. This is not the tag that "appears" on the chain as this tag is first siloed
@@ -9,8 +9,8 @@ import type { IndexedTaggingSecret } from '@aztec/stdlib/logs';
 export class Tag {
   private constructor(public readonly value: Fr) {}
 
-  static async compute(indexedTaggingSecret: IndexedTaggingSecret): Promise<Tag> {
-    const tag = await poseidon2Hash([indexedTaggingSecret.secret.value, indexedTaggingSecret.index]);
+  static async compute(preTag: PreTag): Promise<Tag> {
+    const tag = await poseidon2Hash([preTag.secret.value, preTag.index]);
     return new Tag(tag);
   }
 }

yarn-project/pxe/src/tagging/utils.ts

@@ -1,9 +1,9 @@
-import type { DirectionalAppTaggingSecret, IndexedTaggingSecret } from '@aztec/stdlib/logs';
+import type { DirectionalAppTaggingSecret, PreTag } from '@aztec/stdlib/logs';
 
 // TODO(benesjan): Make this return tags instead - this will moves some complexity from syncTaggedLogs
-export function getIndexedTaggingSecretsForTheWindow(
+export function getPreTagsForTheWindow(
   secretsAndWindows: { secret: DirectionalAppTaggingSecret; leftMostIndex: number; rightMostIndex: number }[],
-): IndexedTaggingSecret[] {
+): PreTag[] {
   const secrets = [];
   for (const secretAndWindow of secretsAndWindows) {
     for (let i = secretAndWindow.leftMostIndex; i <= secretAndWindow.rightMostIndex; i++) {
@@ -15,18 +15,16 @@ export function getIndexedTaggingSecretsForTheWindow(
 
 /**
  * Creates a map from directional app tagging secret to initial index.
- * @param indexedTaggingSecrets - The indexed tagging secrets to get the initial indexes from.
+ * @param preTags - The pre tags to get the initial indexes map from.
  * @returns The map from directional app tagging secret to initial index.
  */
-export function getInitialIndexesMap(
-  indexedTaggingSecrets: { secret: DirectionalAppTaggingSecret; index: number | undefined }[],
-): {
+export function getInitialIndexesMap(preTags: { secret: DirectionalAppTaggingSecret; index: number | undefined }[]): {
   [k: string]: number;
 } {
   const initialIndexes: { [k: string]: number } = {};
 
-  for (const indexedTaggingSecret of indexedTaggingSecrets) {
-    initialIndexes[indexedTaggingSecret.secret.toString()] = indexedTaggingSecret.index ?? 0;
+  for (const preTag of preTags) {
+    initialIndexes[preTag.secret.toString()] = preTag.index ?? 0;
   }
 
   return initialIndexes;