typing LogRetrievalRequest

Author: benesjan

yarn-project/pxe/src/contract_function_simulator/noir-structs/log_retrieval_request.test.ts

@@ -13,6 +13,6 @@ describe('LogRetrievalRequest', () => {
     const request = LogRetrievalRequest.fromFields(serialized);
 
     expect(request.contractAddress).toEqual(AztecAddress.fromBigInt(1n));
-    expect(request.unsiloedTag).toEqual(new Fr(2));
+    expect(request.tag).toEqual(new Fr(2));
   });
 });

yarn-project/pxe/src/contract_function_simulator/noir-structs/log_retrieval_request.ts

@@ -1,6 +1,7 @@
 import { Fr } from '@aztec/foundation/curves/bn254';
 import { FieldReader } from '@aztec/foundation/serialize';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { Tag } from '@aztec/stdlib/logs';
 
 /**
  * Intermediate struct used to perform batch log retrieval by PXE. The `utilityBulkRetrieveLogs` oracle expects values of this
@@ -9,18 +10,18 @@ import { AztecAddress } from '@aztec/stdlib/aztec-address';
 export class LogRetrievalRequest {
   constructor(
     public contractAddress: AztecAddress,
-    public unsiloedTag: Fr,
+    public tag: Tag,
   ) {}
 
   toFields(): Fr[] {
-    return [this.contractAddress.toField(), this.unsiloedTag];
+    return [this.contractAddress.toField(), this.tag.value];
   }
 
   static fromFields(fields: Fr[] | FieldReader): LogRetrievalRequest {
     const reader = FieldReader.asReader(fields);
 
     const contractAddress = AztecAddress.fromField(reader.readField());
-    const unsiloedTag = reader.readField();
+    const unsiloedTag = new Tag(reader.readField());
 
     return new LogRetrievalRequest(contractAddress, unsiloedTag);
   }

yarn-project/pxe/src/logs/log_service.test.ts

@@ -429,7 +429,7 @@ describe('LogService', () => {
   });
 
   describe('bulkRetrieveLogs', () => {
-    const unsiloedTag = Fr.random();
+    const unsiloedTag = new Tag(Fr.random());
 
     beforeEach(() => {
       aztecNode.getPrivateLogsByTags.mockReset();
@@ -458,7 +458,7 @@ describe('LogService', () => {
         txHash.equals(scopedLog.txHash) ? Promise.resolve(indexedTxEffect) : Promise.resolve(undefined),
       );
 
-      const request = new LogRetrievalRequest(contractAddress, scopedLog.log.fields[0]);
+      const request = new LogRetrievalRequest(contractAddress, new Tag(scopedLog.log.fields[0]));
 
       const responses = await logService.bulkRetrieveLogs([request]);
 
@@ -478,7 +478,7 @@ describe('LogService', () => {
         txHash.equals(scopedLog.txHash) ? Promise.resolve(indexedTxEffect) : Promise.resolve(undefined),
       );
 
-      const request = new LogRetrievalRequest(contractAddress, scopedLog.log.fields[0]);
+      const request = new LogRetrievalRequest(contractAddress, new Tag(scopedLog.log.fields[0]));
 
       const responses = await logService.bulkRetrieveLogs([request]);
 
@@ -488,7 +488,7 @@ describe('LogService', () => {
   });
 
   describe('getPublicLogByTag', () => {
-    const tag = Fr.random();
+    const tag = new Tag(Fr.random());
 
     beforeEach(() => {
       aztecNode.getPublicLogsByTagsFromContract.mockReset();
@@ -519,7 +519,7 @@ describe('LogService', () => {
       expect(result.txHash).toEqual(scopedLog.txHash);
       expect(result.firstNullifierInTx).toEqual(indexedTxEffect.data.nullifiers[0]);
 
-      expect(aztecNode.getPublicLogsByTagsFromContract).toHaveBeenCalledWith(logContractAddress, [new Tag(tag)]);
+      expect(aztecNode.getPublicLogsByTagsFromContract).toHaveBeenCalledWith(logContractAddress, [tag]);
       expect(aztecNode.getTxEffect).toHaveBeenCalledWith(scopedLog.txHash);
     });
 
@@ -545,7 +545,7 @@ describe('LogService', () => {
     it('returns log fields that are actually emitted', async () => {
       const logContractAddress = await AztecAddress.random();
       const logPlaintext = [Fr.random()];
-      const logContent = [tag, ...logPlaintext];
+      const logContent = [tag.value, ...logPlaintext];
 
       const log = PublicLog.from({
         contractAddress: logContractAddress,

yarn-project/pxe/src/logs/log_service.ts

@@ -37,14 +37,14 @@ export class LogService {
       logRetrievalRequests.map(async request => {
         // TODO(#14555): remove these internal functions and have node endpoints that do this instead
         const [publicLog, privateLog] = await Promise.all([
-          this.getPublicLogByTag(request.unsiloedTag, request.contractAddress),
-          this.getPrivateLogByTag(await SiloedTag.compute(new Tag(request.unsiloedTag), request.contractAddress)),
+          this.getPublicLogByTag(request.tag, request.contractAddress),
+          this.getPrivateLogByTag(await SiloedTag.compute(request.tag, request.contractAddress)),
         ]);
 
         if (publicLog !== null) {
           if (privateLog !== null) {
             throw new Error(
-              `Found both a public and private log when searching for tag ${request.unsiloedTag} from contract ${request.contractAddress}`,
+              `Found both a public and private log when searching for tag ${request.tag} from contract ${request.contractAddress}`,
             );
           }
 
@@ -69,9 +69,8 @@ export class LogService {
   }
 
   // TODO(#14555): delete this function and implement this behavior in the node instead
-  public async getPublicLogByTag(tag: Fr, contractAddress: AztecAddress): Promise<PublicLogWithTxData | null> {
-    const tagObject = new Tag(tag);
-    const logs = await this.aztecNode.getPublicLogsByTagsFromContract(contractAddress, [tagObject]);
+  public async getPublicLogByTag(tag: Tag, contractAddress: AztecAddress): Promise<PublicLogWithTxData | null> {
+    const logs = await this.aztecNode.getPublicLogsByTagsFromContract(contractAddress, [tag]);
     const logsForTag = logs[0];
 
     if (logsForTag.length == 0) {

yarn-project/stdlib/src/logs/tag.ts

@@ -10,7 +10,6 @@ import type { PreTag } from './pre_tag.js';
  * with a contract address by kernels before being included in the final log.
  */
 export class Tag {
-  // TODO(#14555): Make this constructor private again
   constructor(public readonly value: Fr) {}
 
   static async compute(preTag: PreTag): Promise<Tag> {
@@ -22,6 +21,10 @@ export class Tag {
     return schemas.Fr.transform((fr: Fr) => new Tag(fr));
   }
 
+  toString(): string {
+    return this.value.toString();
+  }
+
   toJSON(): string {
     return this.value.toString();
   }