wip

Author: benesjan

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

@@ -214,13 +214,36 @@ export interface ExecutionDataProvider {
   assertCompatibleOracleVersion(version: number): void;
 
   /**
-   * Returns the next app tag for a given sender and recipient pair.
+   * Returns the next app tag for a given directional app tagging secret.
+   * @param directionalAppTaggingSecret - The secret that's unique for (sender, recipient, contract) tuple while
+   * direction of sender -> recipient matters.
+   * @returns The computed tag.
+   */
+  getNextAppTagAsSender(directionalAppTaggingSecret: Fr): Promise<Fr>;
+
+  /**
+   * Calculates the directional app tagging secret for a given contract, sender and recipient.
    * @param contractAddress - The contract address to silo the secret for
    * @param sender - The address sending the note
    * @param recipient - The address receiving the note
-   * @returns The computed tag.
+   * @returns The directional app tagging secret
+   */
+  calculateDirectionalAppTaggingSecret(
+    contractAddress: AztecAddress,
+    sender: AztecAddress,
+    recipient: AztecAddress,
+  ): Promise<Fr>;
+
+  /**
+   * Updates the local index of the shared tagging secret of a (sender, recipient, contract) tuple if a log with
+   * a larger index is found from the node.
+   * @param directionalAppTaggingSecret - The secret that's unique for (sender, recipient, contract) tuple while
+   * direction of sender -> recipient matters.
+   * @param contractAddress - The address of the contract that the logs are tagged for. Needs to be provided to store
+   * because the function performs second round of siloing which is necessary because kernels do it as well (they silo
+   * first field of the private log which corresponds to the tag).
    */
-  getNextAppTagAsSender(contractAddress: AztecAddress, sender: AztecAddress, recipient: AztecAddress): Promise<Fr>;
+  syncTaggedLogsAsSender(directionalAppTaggingSecret: Fr, contractAddress: AztecAddress): Promise<void>;
 
   /**
    * Synchronizes the private logs tagged with scoped addresses and all the senders in the address book. Stores the found

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

@@ -301,11 +301,9 @@ describe('Private Execution test suite', () => {
       throw new Error(`Unknown address: ${address}. Recipient: ${recipient}, Owner: ${owner}`);
     });
 
-    executionDataProvider.getNextAppTagAsSender.mockImplementation(
-      (_contractAddress: AztecAddress, _sender: AztecAddress, _recipient: AztecAddress) => {
-        return Promise.resolve(Fr.random());
-      },
-    );
+    executionDataProvider.getNextAppTagAsSender.mockImplementation((_directionalAppTaggingSecret: Fr) => {
+      return Promise.resolve(Fr.random());
+    });
     executionDataProvider.getFunctionArtifact.mockImplementation(async (address, selector) => {
       const contract = contracts[address.toString()];
       if (!contract) {

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

@@ -192,7 +192,17 @@ export class PrivateExecutionOracle extends UtilityExecutionOracle implements IP
    * @returns An app tag to be used in a log.
    */
   public async privateGetNextAppTagAsSender(sender: AztecAddress, recipient: AztecAddress): Promise<Fr> {
-    return await this.executionDataProvider.getNextAppTagAsSender(this.contractAddress, sender, recipient);
+    const directionalAppTaggingSecret = await this.executionDataProvider.calculateDirectionalAppTaggingSecret(
+      this.contractAddress,
+      sender,
+      recipient,
+    );
+
+    // TODO(benesjan): In a follow-up PR we will load here the index from the ExecutionTaggingIndexCache if present
+    // and if not we will obtain it from the execution data provider.
+
+    await this.executionDataProvider.syncTaggedLogsAsSender(directionalAppTaggingSecret, this.contractAddress);
+    return this.executionDataProvider.getNextAppTagAsSender(directionalAppTaggingSecret);
   }
 
   /**

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

@@ -274,38 +274,29 @@ export class PXEOracleInterface implements ExecutionDataProvider {
    * @param sender - The address sending the note
    * @param recipient - The address receiving the note
    * @returns The computed tag.
+   * TODO(benesjan): In a follow-up PR this will only return the index and that's it.
    */
-  public async getNextAppTagAsSender(
-    contractAddress: AztecAddress,
-    sender: AztecAddress,
-    recipient: AztecAddress,
-  ): Promise<Fr> {
-    await this.syncTaggedLogsAsSender(contractAddress, sender, recipient);
-
-    const directionalAppTaggingSecret = await this.#calculateDirectionalAppTaggingSecret(
-      contractAddress,
-      sender,
-      recipient,
-    );
-    const [index] = await this.taggingDataProvider.getTaggingSecretsIndexesAsSender([directionalAppTaggingSecret]);
+  public async getNextAppTagAsSender(directionalAppTaggingSecret: Fr): Promise<Fr> {
+    const index = await this.taggingDataProvider.getTaggingSecretsIndexAsSender(directionalAppTaggingSecret);
 
+    // TODO(benesjan): This will be reworked in a follow-up PR where we will store the new indexes in the db once
+    // the execution finishes (then we dump the contents of the ExecutionTaggingIndexCache into the db)
     // Increment the index for next time
-    const contractName = await this.contractDataProvider.getDebugContractName(contractAddress);
-    this.log.debug(`Incrementing app tagging secret at ${contractName}(${contractAddress})`, {
-      directionalAppTaggingSecret,
-      sender,
-      recipient,
-      contractName,
-      contractAddress,
-    });
-
+    // const contractName = await this.contractDataProvider.getDebugContractName(contractAddress);
+    // this.log.debug(`Incrementing app tagging secret at ${contractName}(${contractAddress})`, {
+    //   directionalAppTaggingSecret,
+    //   sender,
+    //   recipient,
+    //   contractName,
+    //   contractAddress,
+    // });
     await this.taggingDataProvider.setTaggingSecretIndexAsSender(directionalAppTaggingSecret, index + 1);
 
     // Compute and return the tag using the current index
     return computeTag(directionalAppTaggingSecret, index);
   }
 
-  async #calculateDirectionalAppTaggingSecret(
+  public async calculateDirectionalAppTaggingSecret(
     contractAddress: AztecAddress,
     sender: AztecAddress,
     recipient: AztecAddress,
@@ -359,26 +350,8 @@ export class PXEOracleInterface implements ExecutionDataProvider {
     }));
   }
 
-  /**
-   * Updates the local index of the shared tagging secret of a sender / recipient pair
-   * if a log with a larger index is found from the node.
-   * @param contractAddress - The address of the contract that the logs are tagged for
-   * @param sender - The address of the sender, we must know the sender's ivsk_m.
-   * @param recipient - The address of the recipient.
-   * TODO: This is used only withing PXEOracleInterface and tests so we most likely just want to hide this.
-   */
-  public async syncTaggedLogsAsSender(
-    contractAddress: AztecAddress,
-    sender: AztecAddress,
-    recipient: AztecAddress,
-  ): Promise<void> {
-    const directionalAppTaggingSecret = await this.#calculateDirectionalAppTaggingSecret(
-      contractAddress,
-      sender,
-      recipient,
-    );
-
-    const [oldIndex] = await this.taggingDataProvider.getTaggingSecretsIndexesAsSender([directionalAppTaggingSecret]);
+  public async syncTaggedLogsAsSender(directionalAppTaggingSecret: Fr, contractAddress: AztecAddress): Promise<void> {
+    const oldIndex = await this.taggingDataProvider.getTaggingSecretsIndexAsSender(directionalAppTaggingSecret);
 
     // This algorithm works such that:
     // 1. If we find minimum consecutive empty logs in a window of logs we set the index to the index of the last log
@@ -417,15 +390,18 @@ export class PXEOracleInterface implements ExecutionDataProvider {
     if (currentIndex !== oldIndex) {
       await this.taggingDataProvider.setTaggingSecretIndexAsSender(directionalAppTaggingSecret, currentIndex);
 
-      this.log.debug(`Syncing logs for sender ${sender} at contract ${contractName}(${contractAddress})`, {
-        sender,
-        secret: directionalAppTaggingSecret,
-        index: currentIndex,
-        contractName,
-        contractAddress,
-      });
+      this.log.debug(
+        `Syncing logs for secret ${directionalAppTaggingSecret.toString()} at contract ${contractName}(${contractAddress})`,
+        {
+          index: currentIndex,
+          contractName,
+          contractAddress,
+        },
+      );
     } else {
-      this.log.debug(`No new logs found for sender ${sender} at contract ${contractName}(${contractAddress})`);
+      this.log.debug(
+        `No new logs found for secret ${directionalAppTaggingSecret.toString()} at contract ${contractName}(${contractAddress})`,
+      );
     }
   }
 

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

@@ -36,12 +36,8 @@ export class TaggingDataProvider {
     );
   }
 
-  getTaggingSecretsIndexesAsSender(directionalAppTaggingSecrets: Fr[]): Promise<number[]> {
-    return Promise.all(
-      directionalAppTaggingSecrets.map(
-        async secret => (await this.#taggingSecretIndexesForSenders.getAsync(secret.toString())) ?? 0,
-      ),
-    );
+  async getTaggingSecretsIndexAsSender(directionalAppTaggingSecret: Fr): Promise<number> {
+    return (await this.#taggingSecretIndexesForSenders.getAsync(directionalAppTaggingSecret.toString())) ?? 0;
   }
 
   getTaggingSecretsIndexesAsRecipient(directionalAppTaggingSecrets: Fr[]): Promise<number[]> {