ox
Version:
Ethereum Standard Library
105 lines • 3.55 kB
TypeScript
import type * as Address from './Address.js';
import type * as Block from './Block.js';
import type * as Errors from './Errors.js';
import * as Hex from './Hex.js';
import type { Compute, OneOf } from './internal/types.js';
/** A Filter as defined in the [Execution API specification](https://github.com/ethereum/execution-apis/blob/main/src/schemas/filter.yaml). */
export type Filter<bigintType = bigint> = Compute<{
/** Address to filter for logs. */
address?: Address.Address | readonly Address.Address[] | null | undefined;
/** Topics to filter for logs. */
topics?: Topics | undefined;
} & OneOf<{
/** Block number or tag to filter logs from. */
fromBlock?: Block.Number<bigintType> | Block.Tag | undefined;
/** Block number or tag to filter logs to. */
toBlock?: Block.Number<bigintType> | Block.Tag | undefined;
} | {
/**
* Hash of the block to filter logs from. Mutually exclusive with
* `fromBlock`/`toBlock`. Added by EIP-234.
*/
blockHash: Block.Hash;
}>>;
/** RPC representation of a {@link ox#Filter.Filter}. */
export type Rpc = Filter<Hex.Hex>;
/** Set of Filter topics. */
export type Topics = readonly Topic[];
/**
* A filter topic.
*
* - `null`: Matches any topic.
* - `Hex`: Matches if the topic is equal.
* - `Hex[]`: Matches if the topic is in the array.
*/
export type Topic = Hex.Hex | readonly Hex.Hex[] | null;
/**
* Converts a {@link ox#Filter.Rpc} to an {@link ox#Filter.Filter}.
*
* @example
* ```ts twoslash
* import { Filter } from 'ox'
*
* const filter = Filter.fromRpc({
* address: '0xd3cda913deb6f67967b99d671a681250403edf27',
* fromBlock: 'latest',
* toBlock: '0x010f2c',
* topics: [
* '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
* null,
* '0x0000000000000000000000000c04d9e9278ec5e4d424476d3ebec70cb5d648d1'
* ]
* })
* // @log: {
* // @log: address: '0xd3cda913deb6f67967b99d671a681250403edf27',
* // @log: fromBlock: 'latest',
* // @log: toBlock: 69420n,
* // @log: topics: [
* // @log: '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
* // @log: null,
* // @log: '0x0000000000000000000000000c04d9e9278ec5e4d424476d3ebec70cb5d648d1',
* // @log: ],
* // @log: }
* ```
*
* @param filter - The RPC filter to convert.
* @returns An instantiated {@link ox#Filter.Filter}.
*/
export declare function fromRpc(filter: Rpc): Filter;
export declare namespace fromRpc {
type ErrorType = Errors.GlobalErrorType;
}
/**
* Converts a {@link ox#Filter.Filter} to a {@link ox#Filter.Rpc}.
*
* @example
* ```ts twoslash
* import { AbiEvent, Filter } from 'ox'
*
* const transfer = AbiEvent.from(
* 'event Transfer(address indexed, address indexed, uint256)'
* )
* const { topics } = AbiEvent.encode(transfer)
*
* const filter = Filter.toRpc({
* address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2',
* topics
* })
* // @log: {
* // @log: address: '0xfba3912ca04dd458c843e2ee08967fc04f3579c2',
* // @log: topics: [
* // @log: '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',
* // @log: ],
* // @log: }
* ```
*
* @param filter - The filter to convert.
* @returns An RPC filter.
*/
export declare function toRpc(filter: toRpc.Input): Rpc;
export declare namespace toRpc {
/** Numberish input accepted by {@link ox#Filter.(toRpc:function)}. */
type Input = Filter<Hex.Hex | bigint | number>;
type ErrorType = Errors.GlobalErrorType;
}
//# sourceMappingURL=Filter.d.ts.map