Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions yarn-project/archiver/src/store/kv_archiver_store.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2782,6 +2782,24 @@ describe('KVArchiverDataStore', () => {
}
});

it('"tag" filter param is respected', async () => {
// Get a random tag from the logs
const targetBlockIndex = randomInt(numBlocksForPublicLogs);
const targetBlock = publishedCheckpoints[targetBlockIndex].checkpoint.blocks[0];
const targetTxIndex = randomInt(getTxsPerBlock(targetBlock));
const targetLogIndex = randomInt(getPublicLogsPerTx(targetBlock, targetTxIndex));
const targetTag = targetBlock.body.txEffects[targetTxIndex].publicLogs[targetLogIndex].fields[0];

const response = await store.getPublicLogs({ tag: targetTag });

expect(response.maxLogsHit).toBeFalsy();
expect(response.logs.length).toBeGreaterThan(0);

for (const extendedLog of response.logs) {
expect(extendedLog.log.fields[0].equals(targetTag)).toBeTruthy();
}
});

it('"afterLog" filter param is respected', async () => {
// Get a random log as reference
const targetBlockIndex = randomInt(numBlocksForPublicLogs);
Expand Down Expand Up @@ -2817,13 +2835,13 @@ describe('KVArchiverDataStore', () => {
}
});

it('"txHash" filter param is ignored when "afterLog" is set', async () => {
// Get random txHash
it('"txHash" filter param is respected when "afterLog" is set', async () => {
// A random txHash should match nothing, even with afterLog set
const txHash = TxHash.random();
const afterLog = new LogId(BlockNumber(1), BlockHash.random(), TxHash.random(), 0, 0);

const response = await store.getPublicLogs({ txHash, afterLog });
expect(response.logs.length).toBeGreaterThan(1);
expect(response.logs.length).toBe(0);
});

it('intersecting works', async () => {
Expand Down
25 changes: 24 additions & 1 deletion yarn-project/archiver/src/store/log_store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -588,11 +588,24 @@ export class LogStore {
txLogs: PublicLog[],
filter: LogFilter = {},
): boolean {
if (filter.fromBlock && blockNumber < filter.fromBlock) {
return false;
}
if (filter.toBlock && blockNumber >= filter.toBlock) {
return false;
}
if (filter.txHash && !txHash.equals(filter.txHash)) {
return false;
}

let maxLogsHit = false;
let logIndex = typeof filter.afterLog?.logIndex === 'number' ? filter.afterLog.logIndex + 1 : 0;
for (; logIndex < txLogs.length; logIndex++) {
const log = txLogs[logIndex];
if (!filter.contractAddress || log.contractAddress.equals(filter.contractAddress)) {
if (
(!filter.contractAddress || log.contractAddress.equals(filter.contractAddress)) &&
(!filter.tag || log.fields[0]?.equals(filter.tag))
) {
results.push(
new ExtendedPublicLog(new LogId(BlockNumber(blockNumber), blockHash, txHash, txIndex, logIndex), log),
);
Expand All @@ -616,6 +629,16 @@ export class LogStore {
txLogs: ContractClassLog[],
filter: LogFilter = {},
): boolean {
if (filter.fromBlock && blockNumber < filter.fromBlock) {
return false;
}
if (filter.toBlock && blockNumber >= filter.toBlock) {
return false;
}
if (filter.txHash && !txHash.equals(filter.txHash)) {
return false;
}

let maxLogsHit = false;
let logIndex = typeof filter.afterLog?.logIndex === 'number' ? filter.afterLog.logIndex + 1 : 0;
for (; logIndex < txLogs.length; logIndex++) {
Expand Down
5 changes: 5 additions & 0 deletions yarn-project/stdlib/src/logs/log_filter.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import type { Fr } from '@aztec/foundation/curves/bn254';

import { z } from 'zod';

import type { AztecAddress } from '../aztec-address/index.js';
Expand All @@ -20,6 +22,8 @@ export type LogFilter = {
afterLog?: LogId;
/** The contract address to filter logs by. */
contractAddress?: AztecAddress;
/** The tag (first field of the log) to filter logs by. */
tag?: Fr;
Comment on lines +25 to +26
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Heads up that if your pxe hits a node that doesn't have tag implemented in the filter, the parameter will be silently dropped. You need to make sure this makes it to v4 before the release, or that all rpc endpoints are updated to use a version that support this.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's on v4: #21477

};

export const LogFilterSchema: ZodFor<LogFilter> = z.object({
Expand All @@ -28,4 +32,5 @@ export const LogFilterSchema: ZodFor<LogFilter> = z.object({
toBlock: schemas.Integer.optional(),
afterLog: LogId.schema.optional(),
contractAddress: schemas.AztecAddress.optional(),
tag: schemas.Fr.optional(),
});
Loading