import type { Abi, Address } from 'abitype' import type { Client } from '../../clients/createClient.js' import type { Transport } from '../../clients/transports/createTransport.js' import type { ErrorType } from '../../errors/utils.js' import type { BlockNumber, BlockTag } from '../../types/block.js' import type { Chain } from '../../types/chain.js' import type { InferEventName, MaybeExtractEventArgsFromAbi, } from '../../types/contract.js' import type { Filter } from '../../types/filter.js' import type { Hex } from '../../types/misc.js' import { type EncodeEventTopicsErrorType, type EncodeEventTopicsParameters, encodeEventTopics, } from '../../utils/abi/encodeEventTopics.js' import type { RequestErrorType } from '../../utils/buildRequest.js' import { type NumberToHexErrorType, numberToHex, } from '../../utils/encoding/toHex.js' import { createFilterRequestScope } from '../../utils/filters/createFilterRequestScope.js' export type CreateContractEventFilterParameters< TAbi extends Abi | readonly unknown[] = Abi, TEventName extends string | undefined = undefined, TArgs extends | MaybeExtractEventArgsFromAbi | undefined = undefined, TStrict extends boolean | undefined = undefined, TFromBlock extends BlockNumber | BlockTag | undefined = undefined, TToBlock extends BlockNumber | BlockTag | undefined = undefined, > = { address?: Address | Address[] abi: TAbi eventName?: InferEventName fromBlock?: TFromBlock | BlockNumber | BlockTag /** * Whether or not the logs must match the indexed/non-indexed arguments in the event ABI item. * @default false */ strict?: TStrict toBlock?: TToBlock | BlockNumber | BlockTag } & (undefined extends TEventName ? { args?: never } : MaybeExtractEventArgsFromAbi< TAbi, TEventName > extends infer TEventFilterArgs ? { args?: | TEventFilterArgs | (TArgs extends TEventFilterArgs ? TArgs : never) } : { args?: never }) export type CreateContractEventFilterReturnType< TAbi extends Abi | readonly unknown[] = Abi, TEventName extends string | undefined = undefined, TArgs extends | MaybeExtractEventArgsFromAbi | undefined = undefined, TStrict extends boolean | undefined = undefined, TFromBlock extends BlockNumber | BlockTag | undefined = undefined, TToBlock extends BlockNumber | BlockTag | undefined = undefined, > = Filter<'event', TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock> export type CreateContractEventFilterErrorType = | EncodeEventTopicsErrorType | RequestErrorType | NumberToHexErrorType | ErrorType /** * Creates a Filter to retrieve event logs that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html) or [`getFilterLogs`](https://viem.sh/docs/actions/public/getFilterLogs.html). * * - Docs: https://viem.sh/docs/contract/createContractEventFilter.html * * @param client - Client to use * @param parameters - {@link CreateContractEventFilterParameters} * @returns [`Filter`](https://viem.sh/docs/glossary/types.html#filter). {@link CreateContractEventFilterReturnType} * * @example * import { createPublicClient, http, parseAbi } from 'viem' * import { mainnet } from 'viem/chains' * import { createContractEventFilter } from 'viem/contract' * * const client = createPublicClient({ * chain: mainnet, * transport: http(), * }) * const filter = await createContractEventFilter(client, { * abi: parseAbi(['event Transfer(address indexed, address indexed, uint256)']), * }) */ export async function createContractEventFilter< TChain extends Chain | undefined, const TAbi extends Abi | readonly unknown[], TEventName extends string | undefined, TArgs extends MaybeExtractEventArgsFromAbi | undefined, TStrict extends boolean | undefined = undefined, TFromBlock extends BlockNumber | BlockTag | undefined = undefined, TToBlock extends BlockNumber | BlockTag | undefined = undefined, >( client: Client, { address, abi, args, eventName, fromBlock, strict, toBlock, }: CreateContractEventFilterParameters< TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock >, ): Promise< CreateContractEventFilterReturnType< TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock > > { const getRequest = createFilterRequestScope(client, { method: 'eth_newFilter', }) const topics = eventName ? encodeEventTopics({ abi, args, eventName, } as unknown as EncodeEventTopicsParameters) : undefined const id: Hex = await client.request({ method: 'eth_newFilter', params: [ { address, fromBlock: typeof fromBlock === 'bigint' ? numberToHex(fromBlock) : fromBlock, toBlock: typeof toBlock === 'bigint' ? numberToHex(toBlock) : toBlock, topics, }, ], }) return { abi, args, eventName, id, request: getRequest(id), strict, type: 'event', } as unknown as CreateContractEventFilterReturnType< TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock > }