Skip to main content
Version: 1.4.2

Type Alias: LogFilter

LogFilter = { address?: string; endBefore?: string; endBlock?: number | "finalized" | "latest"; page?: number; startBlock?: number; startTime?: number; topics?: (string | string[] | null)[]; watch?: boolean | Promise<unknown>; }

Defined in: chain.ts:166

Filter options for getLogs queries across chains.

Properties

address?

optional address?: string

Defined in: chain.ts:180

Contract address to filter logs by.


endBefore?

optional endBefore?: string

Defined in: chain.ts:174

Solana: optional hint txHash for end of iteration.


endBlock?

optional endBlock?: number | "finalized" | "latest"

Defined in: chain.ts:172

Ending block number (inclusive).


page?

optional page?: number

Defined in: chain.ts:184

Page size for pagination.


startBlock?

optional startBlock?: number

Defined in: chain.ts:168

Starting block number (inclusive).


startTime?

optional startTime?: number

Defined in: chain.ts:170

Starting Unix timestamp (inclusive).


topics?

optional topics?: (string | string[] | null)[]

Defined in: chain.ts:182

Topics to filter logs by.


watch?

optional watch?: boolean | Promise<unknown>

Defined in: chain.ts:178

watch mode: polls for new logs after fetching since start (required), until endBlock finality tag (e.g. endBlock=finalized polls only finalized logs); can be a promise to cancel loop