@aztec/archiver 3.0.0-nightly.20251222 → 3.0.0-nightly.20251224

package/src/archiver/archiver_store_test_suite.ts

@@ -30,7 +30,7 @@ import {
   SerializableContractInstance,
   computePublicBytecodeCommitment,
 } from '@aztec/stdlib/contract';
-import { ContractClassLog, LogId, PrivateLog, PublicLog } from '@aztec/stdlib/logs';
+import { ContractClassLog, LogId, PrivateLog, PublicLog, SiloedTag, Tag } from '@aztec/stdlib/logs';
 import { InboxLeaf } from '@aztec/stdlib/messaging';
 import { CheckpointHeader } from '@aztec/stdlib/rollup';
 import {
@@ -2198,46 +2198,35 @@ export function describeArchiverDataStore(
       });
     });
 
-    describe('getLogsByTags', () => {
+    describe('getPrivateLogsByTags', () => {
       const numBlocksForLogs = 3;
       const numTxsPerBlock = 4;
       const numPrivateLogsPerTx = 3;
-      const numPublicLogsPerTx = 2;
 
       let logsCheckpoints: PublishedCheckpoint[];
 
-      const makeTag = (blockNumber: number, txIndex: number, logIndex: number, isPublic = false) =>
-        blockNumber === 1 && txIndex === 0 && logIndex === 0
-          ? Fr.ZERO // Shared tag
-          : new Fr((blockNumber * 100 + txIndex * 10 + logIndex) * (isPublic ? 123 : 1));
+      const makePrivateLogTag = (blockNumber: number, txIndex: number, logIndex: number): SiloedTag =>
+        new SiloedTag(
+          blockNumber === 1 && txIndex === 0 && logIndex === 0
+            ? Fr.ZERO // Shared tag
+            : new Fr(blockNumber * 100 + txIndex * 10 + logIndex),
+        );
 
-      const makePrivateLog = (tag: Fr) =>
+      const makePrivateLog = (tag: SiloedTag) =>
         PrivateLog.from({
-          fields: makeTuple(PRIVATE_LOG_SIZE_IN_FIELDS, i => (!i ? tag : new Fr(tag.toNumber() + i))),
+          fields: makeTuple(PRIVATE_LOG_SIZE_IN_FIELDS, i =>
+            !i ? tag.value : new Fr(tag.value.toBigInt() + BigInt(i)),
+          ),
           emittedLength: PRIVATE_LOG_SIZE_IN_FIELDS,
         });
 
-      const makePublicLog = (tag: Fr) =>
-        PublicLog.from({
-          contractAddress: AztecAddress.fromNumber(1),
-          // Arbitrary length
-          fields: new Array(10).fill(null).map((_, i) => (!i ? tag : new Fr(tag.toNumber() + i))),
-        });
-
       const mockPrivateLogs = (blockNumber: number, txIndex: number) => {
         return times(numPrivateLogsPerTx, (logIndex: number) => {
-          const tag = makeTag(blockNumber, txIndex, logIndex);
+          const tag = makePrivateLogTag(blockNumber, txIndex, logIndex);
           return makePrivateLog(tag);
         });
       };
 
-      const mockPublicLogs = (blockNumber: number, txIndex: number) => {
-        return times(numPublicLogsPerTx, (logIndex: number) => {
-          const tag = makeTag(blockNumber, txIndex, logIndex, /* isPublic */ true);
-          return makePublicLog(tag);
-        });
-      };
-
       const mockCheckpointWithLogs = async (
         blockNumber: number,
         previousArchive?: AppendOnlyTreeSnapshot,
@@ -2253,7 +2242,7 @@ export function describeArchiverDataStore(
         block.body.txEffects = await timesParallel(numTxsPerBlock, async (txIndex: number) => {
           const txEffect = await TxEffect.random();
           txEffect.privateLogs = mockPrivateLogs(blockNumber, txIndex);
-          txEffect.publicLogs = mockPublicLogs(blockNumber, txIndex);
+          txEffect.publicLogs = []; // No public logs needed for private log tests
           return txEffect;
         });
 
@@ -2279,9 +2268,9 @@ export function describeArchiverDataStore(
       });
 
       it('is possible to batch request private logs via tags', async () => {
-        const tags = [makeTag(2, 1, 2), makeTag(1, 2, 0)];
+        const tags = [makePrivateLogTag(2, 1, 2), makePrivateLogTag(1, 2, 0)];
 
-        const logsByTags = await store.getLogsByTags(tags);
+        const logsByTags = await store.getPrivateLogsByTags(tags);
 
         expect(logsByTags).toEqual([
           [
@@ -2303,11 +2292,21 @@ export function describeArchiverDataStore(
         ]);
       });
 
-      it('is possible to batch request all logs (private and public) via tags', async () => {
-        // Tag(1, 0, 0) is shared with the first private log and the first public log.
-        const tags = [makeTag(1, 0, 0)];
+      it('is possible to batch request logs that have the same tag but different content', async () => {
+        const tags = [makePrivateLogTag(1, 2, 1)];
 
-        const logsByTags = await store.getLogsByTags(tags);
+        // Create a checkpoint containing logs that have the same tag as the checkpoints before.
+        // Chain from the last checkpoint's archive
+        const newBlockNumber = numBlocksForLogs + 1;
+        const previousArchive = logsCheckpoints[logsCheckpoints.length - 1].checkpoint.blocks[0].archive;
+        const newCheckpoint = await mockCheckpointWithLogs(newBlockNumber, previousArchive);
+        const newLog = newCheckpoint.checkpoint.blocks[0].body.txEffects[1].privateLogs[1];
+        newLog.fields[0] = tags[0].value;
+        newCheckpoint.checkpoint.blocks[0].body.txEffects[1].privateLogs[1] = newLog;
+        await store.addCheckpoints([newCheckpoint]);
+        await store.addLogs([newCheckpoint.checkpoint.blocks[0]]);
+
+        const logsByTags = await store.getPrivateLogsByTags(tags);
 
         expect(logsByTags).toEqual([
           [
@@ -2317,54 +2316,169 @@ export function describeArchiverDataStore(
               log: makePrivateLog(tags[0]),
               isFromPublic: false,
             }),
+            expect.objectContaining({
+              blockNumber: newBlockNumber,
+              blockHash: L2BlockHash.fromField(await newCheckpoint.checkpoint.blocks[0].header.hash()),
+              log: newLog,
+              isFromPublic: false,
+            }),
+          ],
+        ]);
+      });
+
+      it('is possible to request logs for non-existing tags and determine their position', async () => {
+        const tags = [makePrivateLogTag(99, 88, 77), makePrivateLogTag(1, 1, 1)];
+
+        const logsByTags = await store.getPrivateLogsByTags(tags);
+
+        expect(logsByTags).toEqual([
+          [
+            // No logs for the first tag.
+          ],
+          [
             expect.objectContaining({
               blockNumber: 1,
               blockHash: L2BlockHash.fromField(await logsCheckpoints[1 - 1].checkpoint.blocks[0].header.hash()),
+              log: makePrivateLog(tags[1]),
+              isFromPublic: false,
+            }),
+          ],
+        ]);
+      });
+    });
+
+    describe('getPublicLogsByTagsFromContract', () => {
+      const numBlocksForLogs = 3;
+      const numTxsPerBlock = 4;
+      const numPublicLogsPerTx = 2;
+      const contractAddress = AztecAddress.fromNumber(543254);
+
+      let logsCheckpoints: PublishedCheckpoint[];
+
+      const makePublicLogTag = (blockNumber: number, txIndex: number, logIndex: number): Tag =>
+        new Tag(
+          blockNumber === 1 && txIndex === 0 && logIndex === 0
+            ? Fr.ZERO // Shared tag
+            : new Fr((blockNumber * 100 + txIndex * 10 + logIndex) * 123),
+        );
+
+      const makePublicLog = (tag: Tag) =>
+        PublicLog.from({
+          contractAddress: contractAddress,
+          // Arbitrary length
+          fields: new Array(10).fill(null).map((_, i) => (!i ? tag.value : new Fr(tag.value.toBigInt() + BigInt(i)))),
+        });
+
+      const mockPublicLogs = (blockNumber: number, txIndex: number) => {
+        return times(numPublicLogsPerTx, (logIndex: number) => {
+          const tag = makePublicLogTag(blockNumber, txIndex, logIndex);
+          return makePublicLog(tag);
+        });
+      };
+
+      const mockCheckpointWithLogs = async (
+        blockNumber: number,
+        previousArchive?: AppendOnlyTreeSnapshot,
+      ): Promise<PublishedCheckpoint> => {
+        const block = await L2BlockNew.random(BlockNumber(blockNumber), {
+          checkpointNumber: CheckpointNumber(blockNumber),
+          indexWithinCheckpoint: 0,
+          state: makeStateForBlock(blockNumber, numTxsPerBlock),
+          ...(previousArchive ? { lastArchive: previousArchive } : {}),
+        });
+        block.header.globalVariables.blockNumber = BlockNumber(blockNumber);
+
+        block.body.txEffects = await timesParallel(numTxsPerBlock, async (txIndex: number) => {
+          const txEffect = await TxEffect.random();
+          txEffect.privateLogs = []; // No private logs needed for public log tests
+          txEffect.publicLogs = mockPublicLogs(blockNumber, txIndex);
+          return txEffect;
+        });
+
+        const checkpoint = new Checkpoint(
+          AppendOnlyTreeSnapshot.random(),
+          CheckpointHeader.random(),
+          [block],
+          CheckpointNumber(blockNumber),
+        );
+        return makePublishedCheckpoint(checkpoint, blockNumber);
+      };
+
+      beforeEach(async () => {
+        // Create checkpoints sequentially to chain archive roots
+        logsCheckpoints = [];
+        for (let i = 0; i < numBlocksForLogs; i++) {
+          const previousArchive = i > 0 ? logsCheckpoints[i - 1].checkpoint.blocks[0].archive : undefined;
+          logsCheckpoints.push(await mockCheckpointWithLogs(i + 1, previousArchive));
+        }
+
+        await store.addCheckpoints(logsCheckpoints);
+        await store.addLogs(logsCheckpoints.flatMap(p => p.checkpoint.blocks));
+      });
+
+      it('is possible to batch request public logs via tags', async () => {
+        const tags = [makePublicLogTag(2, 1, 1), makePublicLogTag(1, 2, 0)];
+
+        const logsByTags = await store.getPublicLogsByTagsFromContract(contractAddress, tags);
+
+        expect(logsByTags).toEqual([
+          [
+            expect.objectContaining({
+              blockNumber: 2,
+              blockHash: L2BlockHash.fromField(await logsCheckpoints[2 - 1].checkpoint.blocks[0].header.hash()),
               log: makePublicLog(tags[0]),
               isFromPublic: true,
             }),
           ],
+          [
+            expect.objectContaining({
+              blockNumber: 1,
+              blockHash: L2BlockHash.fromField(await logsCheckpoints[1 - 1].checkpoint.blocks[0].header.hash()),
+              log: makePublicLog(tags[1]),
+              isFromPublic: true,
+            }),
+          ],
         ]);
       });
 
       it('is possible to batch request logs that have the same tag but different content', async () => {
-        const tags = [makeTag(1, 2, 1)];
+        const tags = [makePublicLogTag(1, 2, 1)];
 
         // Create a checkpoint containing logs that have the same tag as the checkpoints before.
         // Chain from the last checkpoint's archive
         const newBlockNumber = numBlocksForLogs + 1;
         const previousArchive = logsCheckpoints[logsCheckpoints.length - 1].checkpoint.blocks[0].archive;
         const newCheckpoint = await mockCheckpointWithLogs(newBlockNumber, previousArchive);
-        const newLog = newCheckpoint.checkpoint.blocks[0].body.txEffects[1].privateLogs[1];
-        newLog.fields[0] = tags[0];
-        newCheckpoint.checkpoint.blocks[0].body.txEffects[1].privateLogs[1] = newLog;
+        const newLog = newCheckpoint.checkpoint.blocks[0].body.txEffects[1].publicLogs[1];
+        newLog.fields[0] = tags[0].value;
+        newCheckpoint.checkpoint.blocks[0].body.txEffects[1].publicLogs[1] = newLog;
         await store.addCheckpoints([newCheckpoint]);
         await store.addLogs([newCheckpoint.checkpoint.blocks[0]]);
 
-        const logsByTags = await store.getLogsByTags(tags);
+        const logsByTags = await store.getPublicLogsByTagsFromContract(contractAddress, tags);
 
         expect(logsByTags).toEqual([
           [
             expect.objectContaining({
               blockNumber: 1,
               blockHash: L2BlockHash.fromField(await logsCheckpoints[1 - 1].checkpoint.blocks[0].header.hash()),
-              log: makePrivateLog(tags[0]),
-              isFromPublic: false,
+              log: makePublicLog(tags[0]),
+              isFromPublic: true,
             }),
             expect.objectContaining({
               blockNumber: newBlockNumber,
               blockHash: L2BlockHash.fromField(await newCheckpoint.checkpoint.blocks[0].header.hash()),
               log: newLog,
-              isFromPublic: false,
+              isFromPublic: true,
             }),
           ],
         ]);
       });
 
       it('is possible to request logs for non-existing tags and determine their position', async () => {
-        const tags = [makeTag(99, 88, 77), makeTag(1, 1, 1)];
+        const tags = [makePublicLogTag(99, 88, 77), makePublicLogTag(1, 1, 0)];
 
-        const logsByTags = await store.getLogsByTags(tags);
+        const logsByTags = await store.getPublicLogsByTagsFromContract(contractAddress, tags);
 
         expect(logsByTags).toEqual([
           [
@@ -2374,8 +2488,8 @@ export function describeArchiverDataStore(
             expect.objectContaining({
               blockNumber: 1,
               blockHash: L2BlockHash.fromField(await logsCheckpoints[1 - 1].checkpoint.blocks[0].header.hash()),
-              log: makePrivateLog(tags[1]),
-              isFromPublic: false,
+              log: makePublicLog(tags[1]),
+              isFromPublic: true,
             }),
           ],
         ]);

package/src/archiver/config.ts

@@ -1,4 +1,4 @@
-import { type BlobSinkConfig, blobSinkConfigMapping } from '@aztec/blob-sink/client/config';
+import { type BlobClientConfig, blobClientConfigMapping } from '@aztec/blob-client/client/config';
 import { type L1ContractsConfig, l1ContractsConfigMappings } from '@aztec/ethereum/config';
 import { l1ContractAddressesMapping } from '@aztec/ethereum/l1-contract-addresses';
 import { type L1ReaderConfig, l1ReaderConfigMappings } from '@aztec/ethereum/l1-reader';
@@ -18,10 +18,14 @@ import type { ArchiverSpecificConfig } from '@aztec/stdlib/interfaces/server';
  * Results of calls to eth_blockNumber are cached by viem with this cache being updated periodically at the interval specified by viemPollingIntervalMS.
  * As a result the maximum observed polling time for new blocks will be viemPollingIntervalMS + archiverPollingIntervalMS.
  */
-export type ArchiverConfig = ArchiverSpecificConfig & L1ReaderConfig & L1ContractsConfig & BlobSinkConfig & ChainConfig;
+export type ArchiverConfig = ArchiverSpecificConfig &
+  L1ReaderConfig &
+  L1ContractsConfig &
+  BlobClientConfig &
+  ChainConfig;
 
 export const archiverConfigMappings: ConfigMappingsType<ArchiverConfig> = {
-  ...blobSinkConfigMapping,
+  ...blobClientConfigMapping,
   archiverPollingIntervalMS: {
     env: 'ARCHIVER_POLLING_INTERVAL_MS',
     description: 'The polling interval in ms for retrieving new L2 blocks and encrypted logs.',

package/src/archiver/kv_archiver_store/kv_archiver_store.ts

@@ -17,7 +17,7 @@ import type {
   UtilityFunctionWithMembershipProof,
 } from '@aztec/stdlib/contract';
 import type { GetContractClassLogsResponse, GetPublicLogsResponse } from '@aztec/stdlib/interfaces/client';
-import type { LogFilter, TxScopedL2Log } from '@aztec/stdlib/logs';
+import type { LogFilter, SiloedTag, Tag, TxScopedL2Log } from '@aztec/stdlib/logs';
 import type { BlockHeader, TxHash, TxReceipt } from '@aztec/stdlib/tx';
 import type { UInt64 } from '@aztec/stdlib/types';
 
@@ -318,16 +318,17 @@ export class KVArchiverDataStore implements ArchiverDataStore, ContractDataSourc
     return this.#messageStore.getL1ToL2Messages(checkpointNumber);
   }
 
-  /**
-   * Gets all logs that match any of the received tags (i.e. logs with their first field equal to a tag).
-   * @param tags - The tags to filter the logs by.
-   * @param logsPerTag - How many logs to return per tag. Default returns everything
-   * @returns For each received tag, an array of matching logs is returned. An empty array implies no logs match
-   * that tag.
-   */
-  getLogsByTags(tags: Fr[], logsPerTag?: number): Promise<TxScopedL2Log[][]> {
+  getPrivateLogsByTags(tags: SiloedTag[]): Promise<TxScopedL2Log[][]> {
+    try {
+      return this.#logStore.getPrivateLogsByTags(tags);
+    } catch (err) {
+      return Promise.reject(err);
+    }
+  }
+
+  getPublicLogsByTagsFromContract(contractAddress: AztecAddress, tags: Tag[]): Promise<TxScopedL2Log[][]> {
     try {
-      return this.#logStore.getLogsByTags(tags, logsPerTag);
+      return this.#logStore.getPublicLogsByTagsFromContract(contractAddress, tags);
     } catch (err) {
       return Promise.reject(err);
     }