viem
Version:
106 lines • 6.45 kB
TypeScript
import type { Address } from 'abitype';
import type { JsonRpcAccount } from '../accounts/types.js';
import { type ParseAccountErrorType } from '../accounts/utils/parseAccount.js';
import type { ErrorType } from '../errors/utils.js';
import type { Account } from '../types/account.js';
import type { Chain } from '../types/chain.js';
import type { EIP1193RequestFn, EIP1474Methods, RpcSchema } from '../types/eip1193.js';
import type { ExactPartial, Prettify } from '../types/utils.js';
import type { CcipRequestParameters, CcipRequestReturnType } from '../utils/ccip.js';
import type { PublicActions } from './decorators/public.js';
import type { WalletActions } from './decorators/wallet.js';
import type { Transport } from './transports/createTransport.js';
export type ClientConfig<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, accountOrAddress extends Account | Address | undefined = Account | Address | undefined, rpcSchema extends RpcSchema | undefined = undefined> = {
/** The Account to use for the Client. This will be used for Actions that require an account as an argument. */
account?: accountOrAddress | Account | Address | undefined;
/** Flags for batch settings. */
batch?: {
/** Toggle to enable `eth_call` multicall aggregation. */
multicall?: boolean | Prettify<MulticallBatchOptions> | undefined;
} | undefined;
/**
* Time (in ms) that cached data will remain in memory.
* @default 4_000
*/
cacheTime?: number | undefined;
/**
* [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration.
* If `false`, the client will not support offchain CCIP lookups.
*/
ccipRead?: {
/**
* A function that will be called to make the offchain CCIP lookup request.
* @see https://eips.ethereum.org/EIPS/eip-3668#client-lookup-protocol
*/
request?: (parameters: CcipRequestParameters) => Promise<CcipRequestReturnType>;
} | false | undefined;
/** Chain for the client. */
chain?: Chain | undefined | chain;
/** A key for the client. */
key?: string | undefined;
/** A name for the client. */
name?: string | undefined;
/**
* Frequency (in ms) for polling enabled actions & events.
* @default 4_000
*/
pollingInterval?: number | undefined;
/**
* Typed JSON-RPC schema for the client.
*/
rpcSchema?: rpcSchema | undefined;
/** The RPC transport */
transport: transport;
/** The type of client. */
type?: string | undefined;
};
type ExtendableProtectedActions<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = Pick<PublicActions<transport, chain, account>, 'call' | 'createContractEventFilter' | 'createEventFilter' | 'estimateContractGas' | 'estimateGas' | 'getBlock' | 'getBlockNumber' | 'getChainId' | 'getContractEvents' | 'getEnsText' | 'getFilterChanges' | 'getGasPrice' | 'getLogs' | 'getTransaction' | 'getTransactionCount' | 'getTransactionReceipt' | 'prepareTransactionRequest' | 'readContract' | 'sendRawTransaction' | 'simulateContract' | 'uninstallFilter' | 'watchBlockNumber' | 'watchContractEvent'> & Pick<WalletActions<chain, account>, 'sendTransaction' | 'writeContract'>;
export type Client<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined, rpcSchema extends RpcSchema | undefined = undefined, extended extends Extended | undefined = Extended | undefined> = Client_Base<transport, chain, account, rpcSchema> & (extended extends Extended ? extended : unknown) & {
extend: <const client extends Extended & ExactPartial<ExtendableProtectedActions<transport, chain, account>>>(fn: (client: Client<transport, chain, account, rpcSchema, extended>) => client) => Client<transport, chain, account, rpcSchema, Prettify<client> & (extended extends Extended ? extended : unknown)>;
};
type Client_Base<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined, rpcSchema extends RpcSchema | undefined = undefined> = {
/** The Account of the Client. */
account: account;
/** Flags for batch settings. */
batch?: ClientConfig['batch'] | undefined;
/** Time (in ms) that cached data will remain in memory. */
cacheTime: number;
/** [CCIP Read](https://eips.ethereum.org/EIPS/eip-3668) configuration. */
ccipRead?: ClientConfig['ccipRead'] | undefined;
/** Chain for the client. */
chain: chain;
/** A key for the client. */
key: string;
/** A name for the client. */
name: string;
/** Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. */
pollingInterval: number;
/** Request function wrapped with friendly error handling */
request: EIP1193RequestFn<rpcSchema extends undefined ? EIP1474Methods : rpcSchema>;
/** The RPC transport */
transport: ReturnType<transport>['config'] & ReturnType<transport>['value'];
/** The type of client. */
type: string;
/** A unique ID for the client. */
uid: string;
};
type Extended = Prettify<{
[_ in keyof Client_Base]?: undefined;
} & {
[key: string]: unknown;
}>;
export type MulticallBatchOptions = {
/** The maximum size (in bytes) for each calldata chunk. @default 1_024 */
batchSize?: number | undefined;
/** The maximum number of milliseconds to wait before sending a batch. @default 0 */
wait?: number | undefined;
};
export type CreateClientErrorType = ParseAccountErrorType | ErrorType;
export declare function createClient<transport extends Transport, chain extends Chain | undefined = undefined, accountOrAddress extends Account | Address | undefined = undefined, rpcSchema extends RpcSchema | undefined = undefined>(parameters: ClientConfig<transport, chain, accountOrAddress, rpcSchema>): Prettify<Client<transport, chain, accountOrAddress extends Address ? Prettify<JsonRpcAccount<accountOrAddress>> : accountOrAddress, rpcSchema>>;
/**
* Defines a typed JSON-RPC schema for the client.
* Note: This is a runtime noop function.
*/
export declare function rpcSchema<rpcSchema extends RpcSchema>(): rpcSchema;
export {};
//# sourceMappingURL=createClient.d.ts.map