import type { AbiEvent, 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 { MaybeAbiEventName, MaybeExtractEventArgsFromAbi, } from '../../types/contract.js' import type { Filter } from '../../types/filter.js' import type { Hex, LogTopic } from '../../types/misc.js' import type { Prettify } from '../../types/utils.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 CreateEventFilterParameters< TAbiEvent extends AbiEvent | undefined = undefined, TAbiEvents extends | readonly AbiEvent[] | readonly unknown[] | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined, TStrict extends boolean | undefined = undefined, TFromBlock extends BlockNumber | BlockTag | undefined = undefined, TToBlock extends BlockNumber | BlockTag | undefined = undefined, _EventName extends string | undefined = MaybeAbiEventName, _Args extends | MaybeExtractEventArgsFromAbi | undefined = undefined, > = { address?: Address | Address[] fromBlock?: TFromBlock | BlockNumber | BlockTag toBlock?: TToBlock | BlockNumber | BlockTag } & (MaybeExtractEventArgsFromAbi< TAbiEvents, _EventName > extends infer TEventFilterArgs ? | { args: | TEventFilterArgs | (_Args extends TEventFilterArgs ? _Args : never) event: TAbiEvent events?: never /** * Whether or not the logs must match the indexed/non-indexed arguments on `event`. * @default false */ strict?: TStrict } | { args?: never event?: TAbiEvent events?: never /** * Whether or not the logs must match the indexed/non-indexed arguments on `event`. * @default false */ strict?: TStrict } | { args?: never event?: never events: TAbiEvents /** * Whether or not the logs must match the indexed/non-indexed arguments on `event`. * @default false */ strict?: TStrict } | { args?: never event?: never events?: never strict?: never } : { args?: never event?: never events?: never strict?: never }) export type CreateEventFilterReturnType< TAbiEvent extends AbiEvent | undefined = undefined, TAbiEvents extends | readonly AbiEvent[] | readonly unknown[] | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined, TStrict extends boolean | undefined = undefined, TFromBlock extends BlockNumber | BlockTag | undefined = undefined, TToBlock extends BlockNumber | BlockTag | undefined = undefined, _EventName extends string | undefined = MaybeAbiEventName, _Args extends | MaybeExtractEventArgsFromAbi | undefined = undefined, > = Prettify< Filter<'event', TAbiEvents, _EventName, _Args, TStrict, TFromBlock, TToBlock> > export type CreateEventFilterErrorType = | EncodeEventTopicsErrorType | RequestErrorType | NumberToHexErrorType | ErrorType /** * Creates a [`Filter`](https://viem.sh/docs/glossary/types.html#filter) to listen for new events that can be used with [`getFilterChanges`](https://viem.sh/docs/actions/public/getFilterChanges.html). * * - Docs: https://viem.sh/docs/actions/public/createEventFilter.html * - JSON-RPC Methods: [`eth_newFilter`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_newfilter) * * @param client - Client to use * @param parameters - {@link CreateEventFilterParameters} * @returns [`Filter`](https://viem.sh/docs/glossary/types.html#filter). {@link CreateEventFilterReturnType} * * @example * import { createPublicClient, http } from 'viem' * import { mainnet } from 'viem/chains' * import { createEventFilter } from 'viem/public' * * const client = createPublicClient({ * chain: mainnet, * transport: http(), * }) * const filter = await createEventFilter(client, { * address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2', * }) */ export async function createEventFilter< TChain extends Chain | undefined, const TAbiEvent extends AbiEvent | undefined = undefined, const TAbiEvents extends | readonly AbiEvent[] | readonly unknown[] | undefined = TAbiEvent extends AbiEvent ? [TAbiEvent] : undefined, TStrict extends boolean | undefined = undefined, TFromBlock extends BlockNumber | BlockTag | undefined = undefined, TToBlock extends BlockNumber | BlockTag | undefined = undefined, _EventName extends string | undefined = MaybeAbiEventName, _Args extends | MaybeExtractEventArgsFromAbi | undefined = undefined, >( client: Client, { address, args, event, events: events_, fromBlock, strict, toBlock, }: CreateEventFilterParameters< TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args > = {} as any, ): Promise< CreateEventFilterReturnType< TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args > > { const events = events_ ?? (event ? [event] : undefined) const getRequest = createFilterRequestScope(client, { method: 'eth_newFilter', }) let topics: LogTopic[] = [] if (events) { topics = [ (events as AbiEvent[]).flatMap((event) => encodeEventTopics({ abi: [event], eventName: (event as AbiEvent).name, args, } as EncodeEventTopicsParameters), ), ] if (event) topics = topics[0] as LogTopic[] } 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.length ? { topics } : {}), }, ], }) return { abi: events, args, eventName: event ? (event as AbiEvent).name : undefined, fromBlock, id, request: getRequest(id), strict, toBlock, type: 'event', } as unknown as CreateEventFilterReturnType< TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args > }