viem 0.2.11 → 0.2.13

package/src/clients/createClient.ts

@@ -0,0 +1,79 @@
+import type { Chain } from '../types/index.js'
+import type { Requests } from '../types/eip1193.js'
+import { uid } from '../utils/uid.js'
+import type {
+  BaseRpcRequests,
+  Transport,
+} from './transports/createTransport.js'
+
+export type ClientConfig<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+> = {
+  /** Chain for the client. */
+  chain?: TChain
+  /** A key for the client. */
+  key?: string
+  /** A name for the client. */
+  name?: string
+  /**
+   * Frequency (in ms) for polling enabled actions & events.
+   * @default 4_000
+   */
+  pollingInterval?: number
+  /** The RPC transport */
+  transport: TTransport
+  /** The type of client. */
+  type?: string
+}
+
+export type Client<
+  TTransport extends Transport = Transport,
+  TRequests extends BaseRpcRequests = Requests,
+  TChain extends Chain | undefined = Chain | undefined,
+> = {
+  /** Chain for the client. */
+  chain: TChain
+  /** 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: TRequests['request']
+  /** The RPC transport */
+  transport: ReturnType<TTransport>['config'] & ReturnType<TTransport>['value']
+  /** The type of client. */
+  type: string
+  /** A unique ID for the client. */
+  uid: string
+}
+
+/**
+ * @description Creates a base client with the given transport.
+ */
+export function createClient<
+  TTransport extends Transport,
+  TRequests extends BaseRpcRequests,
+  TChain extends Chain | undefined = undefined,
+>({
+  chain,
+  key = 'base',
+  name = 'Base Client',
+  pollingInterval = 4_000,
+  transport,
+  type = 'base',
+}: ClientConfig<TTransport, TChain>): Client<TTransport, TRequests, TChain> {
+  const { config, request, value } = transport({ chain, pollingInterval })
+  return {
+    chain: chain as TChain,
+    key,
+    name,
+    pollingInterval,
+    request,
+    transport: { ...config, ...value },
+    type,
+    uid: uid(),
+  }
+}

package/src/clients/createPublicClient.ts

@@ -0,0 +1,55 @@
+import type { PublicRequests } from '../types/eip1193.js'
+import type { Transport } from './transports/createTransport.js'
+import type { Client, ClientConfig } from './createClient.js'
+import { createClient } from './createClient.js'
+import { publicActions } from './decorators/index.js'
+import type { PublicActions } from './decorators/index.js'
+import type { Chain, Prettify } from '../types/index.js'
+
+export type PublicClientConfig<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+> = Pick<
+  ClientConfig<TTransport, TChain>,
+  'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+>
+
+export type PublicClient<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TIncludeActions extends boolean = true,
+> = Prettify<
+  Client<TTransport, PublicRequests, TChain> &
+    (TIncludeActions extends true ? PublicActions<TTransport, TChain> : unknown)
+>
+
+/**
+ * @description Creates a public client with a given transport.
+ */
+export function createPublicClient<
+  TTransport extends Transport,
+  TChain extends Chain | undefined = undefined,
+>({
+  chain,
+  key = 'public',
+  name = 'Public Client',
+  transport,
+  pollingInterval,
+}: PublicClientConfig<TTransport, TChain>): PublicClient<
+  TTransport,
+  TChain,
+  true
+> {
+  const client = createClient({
+    chain,
+    key,
+    name,
+    pollingInterval,
+    transport,
+    type: 'publicClient',
+  }) as PublicClient<TTransport, TChain>
+  return {
+    ...client,
+    ...publicActions(client),
+  }
+}

package/src/clients/createTestClient.ts

@@ -0,0 +1,68 @@
+import type { Chain } from '../types/index.js'
+import type { TestRequests } from '../types/eip1193.js'
+import type { Client, ClientConfig } from './createClient.js'
+import { createClient } from './createClient.js'
+import { testActions } from './decorators/index.js'
+import type { TestActions } from './decorators/index.js'
+import type { Transport } from './transports/createTransport.js'
+
+export type TestClientMode = 'anvil' | 'hardhat'
+
+export type TestClientConfig<
+  TMode extends TestClientMode = TestClientMode,
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+> = Pick<
+  ClientConfig<TTransport, TChain>,
+  'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+> & {
+  /** Mode of the test client. Available: "anvil" | "hardhat" */
+  mode: TMode
+}
+
+export type TestClient<
+  TMode extends TestClientMode = TestClientMode,
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TIncludeActions extends boolean = true,
+> = Client<TTransport, TestRequests<TMode>, TChain> &
+  (TIncludeActions extends true ? TestActions : unknown) & {
+    mode: TMode
+  }
+
+/**
+ * @description Creates a test client with a given transport.
+ */
+export function createTestClient<
+  TMode extends TestClientMode,
+  TTransport extends Transport,
+  TChain extends Chain | undefined = undefined,
+>({
+  chain,
+  key = 'test',
+  name = 'Test Client',
+  mode,
+  pollingInterval,
+  transport,
+}: TestClientConfig<TMode, TTransport, TChain>): TestClient<
+  TMode,
+  TTransport,
+  TChain,
+  true
+> {
+  const client = {
+    ...createClient({
+      chain,
+      key,
+      name,
+      pollingInterval,
+      transport,
+      type: 'testClient',
+    }),
+    mode,
+  } as TestClient<TMode, TTransport, TChain>
+  return {
+    ...client,
+    ...testActions(client),
+  }
+}

package/src/clients/createWalletClient.ts

@@ -0,0 +1,89 @@
+import type { Client, ClientConfig } from './createClient.js'
+import { createClient } from './createClient.js'
+import type { Transport } from './transports/createTransport.js'
+import type {
+  Account,
+  Address,
+  Chain,
+  JsonRpcAccount,
+  Prettify,
+} from '../types/index.js'
+import { walletActions } from './decorators/index.js'
+import type { WalletActions } from './decorators/index.js'
+import { parseAccount } from '../utils/index.js'
+import type { Requests } from '../types/eip1193.js'
+
+export type WalletClientConfig<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TAccountOrAddress extends Account | Address | undefined =
+    | Account
+    | Address
+    | undefined,
+> = Pick<
+  ClientConfig<TTransport, TChain>,
+  'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+> & {
+  /** The Account to use for the Wallet Client. This will be used for Actions that require an account as an argument. */
+  account?: TAccountOrAddress
+}
+
+export type WalletClient<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends Account | undefined = Account | undefined,
+  TIncludeActions extends boolean = true,
+> = Prettify<
+  Client<TTransport, Requests, TChain> &
+    (TIncludeActions extends true
+      ? WalletActions<TChain, TAccount>
+      : unknown) & {
+      /** The Account to use for the Wallet Client. */
+      account: TAccount
+    }
+>
+
+/**
+ * @description Creates a wallet client with a given transport.
+ */
+export function createWalletClient<
+  TTransport extends Transport,
+  TChain extends Chain | undefined = undefined,
+  TAccountOrAddress extends Account | Address | undefined = undefined,
+>({
+  account,
+  chain,
+  transport,
+  key = 'wallet',
+  name = 'Wallet Client',
+  pollingInterval,
+}: WalletClientConfig<TTransport, TChain, TAccountOrAddress>): WalletClient<
+  TTransport,
+  TChain,
+  TAccountOrAddress extends Address
+    ? Prettify<JsonRpcAccount<TAccountOrAddress>>
+    : TAccountOrAddress,
+  true
+> {
+  const client = {
+    ...createClient({
+      chain,
+      key,
+      name,
+      pollingInterval,
+      transport: (opts) => transport({ ...opts, retryCount: 0 }),
+      type: 'walletClient',
+    }),
+    account: account ? parseAccount(account) : undefined,
+  } as WalletClient<
+    TTransport,
+    TChain,
+    TAccountOrAddress extends Address
+      ? JsonRpcAccount<TAccountOrAddress>
+      : TAccountOrAddress
+  >
+  return {
+    ...client,
+    ...walletActions(client),
+  }
+}

package/src/clients/decorators/index.ts

@@ -0,0 +1,8 @@
+export type { PublicActions } from './public.js'
+export { publicActions } from './public.js'
+
+export type { TestActions } from './test.js'
+export { testActions } from './test.js'
+
+export type { WalletActions } from './wallet.js'
+export { walletActions } from './wallet.js'

package/src/clients/decorators/public.ts

@@ -0,0 +1,323 @@
+import type { Abi, AbiEvent } from 'abitype'
+import type {
+  GetEnsAddressParameters,
+  GetEnsAddressReturnType,
+  GetEnsAvatarParameters,
+  GetEnsAvatarReturnType,
+  GetEnsNameParameters,
+  GetEnsNameReturnType,
+  GetEnsResolverParameters,
+  GetEnsResolverReturnType,
+  GetEnsTextParameters,
+  GetEnsTextReturnType,
+} from '../../actions/ens/index.js'
+import {
+  getEnsAddress,
+  getEnsAvatar,
+  getEnsName,
+  getEnsResolver,
+  getEnsText,
+} from '../../actions/ens/index.js'
+import type {
+  CallParameters,
+  CallReturnType,
+  CreateBlockFilterReturnType,
+  CreateContractEventFilterParameters,
+  CreateContractEventFilterReturnType,
+  CreateEventFilterParameters,
+  CreateEventFilterReturnType,
+  CreatePendingTransactionFilterReturnType,
+  EstimateContractGasParameters,
+  EstimateContractGasReturnType,
+  EstimateGasParameters,
+  EstimateGasReturnType,
+  GetBalanceParameters,
+  GetBalanceReturnType,
+  GetBlockNumberParameters,
+  GetBlockNumberReturnType,
+  GetBlockParameters,
+  GetBlockReturnType,
+  GetBlockTransactionCountParameters,
+  GetBlockTransactionCountReturnType,
+  GetBytecodeParameters,
+  GetBytecodeReturnType,
+  GetChainIdReturnType,
+  GetFeeHistoryParameters,
+  GetFeeHistoryReturnType,
+  GetFilterChangesParameters,
+  GetFilterChangesReturnType,
+  GetFilterLogsParameters,
+  GetFilterLogsReturnType,
+  GetGasPriceReturnType,
+  GetLogsParameters,
+  GetLogsReturnType,
+  GetStorageAtParameters,
+  GetStorageAtReturnType,
+  GetTransactionConfirmationsParameters,
+  GetTransactionConfirmationsReturnType,
+  GetTransactionCountParameters,
+  GetTransactionCountReturnType,
+  GetTransactionParameters,
+  GetTransactionReceiptParameters,
+  GetTransactionReceiptReturnType,
+  GetTransactionReturnType,
+  MulticallParameters,
+  MulticallReturnType,
+  ReadContractParameters,
+  ReadContractReturnType,
+  SimulateContractParameters,
+  SimulateContractReturnType,
+  UninstallFilterParameters,
+  UninstallFilterReturnType,
+  WaitForTransactionReceiptParameters,
+  WaitForTransactionReceiptReturnType,
+  WatchBlockNumberParameters,
+  WatchBlockNumberReturnType,
+  WatchBlocksParameters,
+  WatchBlocksReturnType,
+  WatchContractEventParameters,
+  WatchContractEventReturnType,
+  WatchEventParameters,
+  WatchEventReturnType,
+  WatchPendingTransactionsParameters,
+  WatchPendingTransactionsReturnType,
+} from '../../actions/public/index.js'
+import {
+  call,
+  createBlockFilter,
+  createContractEventFilter,
+  createEventFilter,
+  createPendingTransactionFilter,
+  estimateContractGas,
+  estimateGas,
+  getBalance,
+  getBlock,
+  getBlockNumber,
+  getBlockTransactionCount,
+  getBytecode,
+  getChainId,
+  getFeeHistory,
+  getFilterChanges,
+  getFilterLogs,
+  getGasPrice,
+  getLogs,
+  getStorageAt,
+  getTransaction,
+  getTransactionConfirmations,
+  getTransactionCount,
+  getTransactionReceipt,
+  multicall,
+  readContract,
+  simulateContract,
+  uninstallFilter,
+  waitForTransactionReceipt,
+  watchBlockNumber,
+  watchBlocks,
+  watchContractEvent,
+  watchEvent,
+  watchPendingTransactions,
+} from '../../actions/public/index.js'
+import type {
+  Chain,
+  ContractFunctionConfig,
+  FilterType,
+  MaybeExtractEventArgsFromAbi,
+} from '../../types/index.js'
+import type { PublicClient } from '../createPublicClient.js'
+import type { Transport } from '../transports/index.js'
+
+export type PublicActions<
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+> = {
+  call: (args: CallParameters<TChain>) => Promise<CallReturnType>
+  createBlockFilter: () => Promise<CreateBlockFilterReturnType>
+  createContractEventFilter: <
+    TAbi extends Abi | readonly unknown[],
+    TEventName extends string | undefined,
+    TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName> | undefined,
+  >(
+    args: CreateContractEventFilterParameters<TAbi, TEventName, TArgs>,
+  ) => Promise<CreateContractEventFilterReturnType<TAbi, TEventName, TArgs>>
+  createEventFilter: <
+    TAbiEvent extends AbiEvent | undefined,
+    TAbi extends Abi | readonly unknown[],
+    TEventName extends string | undefined,
+    TArgs extends MaybeExtractEventArgsFromAbi<TAbi, TEventName> | undefined,
+  >(
+    args?: CreateEventFilterParameters<TAbiEvent, TAbi, TEventName, TArgs>,
+  ) => Promise<CreateEventFilterReturnType<TAbiEvent, TAbi, TEventName, TArgs>>
+  createPendingTransactionFilter: () => Promise<CreatePendingTransactionFilterReturnType>
+  estimateContractGas: <
+    TChain extends Chain | undefined,
+    TAbi extends Abi | readonly unknown[],
+    TFunctionName extends string,
+  >(
+    args: EstimateContractGasParameters<TAbi, TFunctionName, TChain>,
+  ) => Promise<EstimateContractGasReturnType>
+  estimateGas: (
+    args: EstimateGasParameters<TChain>,
+  ) => Promise<EstimateGasReturnType>
+  getBalance: (args: GetBalanceParameters) => Promise<GetBalanceReturnType>
+  getBlock: (args?: GetBlockParameters) => Promise<GetBlockReturnType<TChain>>
+  getBlockNumber: (
+    args?: GetBlockNumberParameters,
+  ) => Promise<GetBlockNumberReturnType>
+  getBlockTransactionCount: (
+    args?: GetBlockTransactionCountParameters,
+  ) => Promise<GetBlockTransactionCountReturnType>
+  getBytecode: (args: GetBytecodeParameters) => Promise<GetBytecodeReturnType>
+  getChainId: () => Promise<GetChainIdReturnType>
+  getEnsAddress: (
+    args: GetEnsAddressParameters,
+  ) => Promise<GetEnsAddressReturnType>
+  getEnsAvatar: (
+    args: GetEnsAvatarParameters,
+  ) => Promise<GetEnsAvatarReturnType>
+  getEnsName: (args: GetEnsNameParameters) => Promise<GetEnsNameReturnType>
+  getEnsResolver: (
+    args: GetEnsResolverParameters,
+  ) => Promise<GetEnsResolverReturnType>
+  getEnsText: (args: GetEnsTextParameters) => Promise<GetEnsTextReturnType>
+  getFeeHistory: (
+    args: GetFeeHistoryParameters,
+  ) => Promise<GetFeeHistoryReturnType>
+  getFilterChanges: <
+    TFilterType extends FilterType,
+    TAbiEvent extends AbiEvent | undefined,
+    TAbi extends Abi | readonly unknown[],
+    TEventName extends string | undefined,
+  >(
+    args: GetFilterChangesParameters<TFilterType, TAbiEvent, TAbi, TEventName>,
+  ) => Promise<
+    GetFilterChangesReturnType<TFilterType, TAbiEvent, TAbi, TEventName>
+  >
+  getFilterLogs: <
+    TAbiEvent extends AbiEvent | undefined,
+    TAbi extends Abi | readonly unknown[],
+    TEventName extends string | undefined,
+  >(
+    args: GetFilterLogsParameters<TAbiEvent, TAbi, TEventName>,
+  ) => Promise<GetFilterLogsReturnType<TAbiEvent, TAbi, TEventName>>
+  getGasPrice: () => Promise<GetGasPriceReturnType>
+  getLogs: <TAbiEvent extends AbiEvent | undefined>(
+    args?: GetLogsParameters<TAbiEvent>,
+  ) => Promise<GetLogsReturnType<TAbiEvent>>
+  getStorageAt: (
+    args: GetStorageAtParameters,
+  ) => Promise<GetStorageAtReturnType>
+  getTransaction: (
+    args: GetTransactionParameters,
+  ) => Promise<GetTransactionReturnType<TChain>>
+  getTransactionConfirmations: (
+    args: GetTransactionConfirmationsParameters<TChain>,
+  ) => Promise<GetTransactionConfirmationsReturnType>
+  getTransactionCount: (
+    args: GetTransactionCountParameters,
+  ) => Promise<GetTransactionCountReturnType>
+  getTransactionReceipt: (
+    args: GetTransactionReceiptParameters,
+  ) => Promise<GetTransactionReceiptReturnType<TChain>>
+  multicall: <
+    TContracts extends ContractFunctionConfig[],
+    TAllowFailure extends boolean = true,
+  >(
+    args: MulticallParameters<TContracts, TAllowFailure>,
+  ) => Promise<MulticallReturnType<TContracts, TAllowFailure>>
+  readContract: <
+    TAbi extends Abi | readonly unknown[],
+    TFunctionName extends string,
+  >(
+    args: ReadContractParameters<TAbi, TFunctionName>,
+  ) => Promise<ReadContractReturnType<TAbi, TFunctionName>>
+  simulateContract: <
+    TAbi extends Abi | readonly unknown[] = Abi,
+    TFunctionName extends string = any,
+    TChainOverride extends Chain | undefined = undefined,
+  >(
+    args: SimulateContractParameters<
+      TAbi,
+      TFunctionName,
+      TChain,
+      TChainOverride
+    >,
+  ) => Promise<
+    SimulateContractReturnType<TAbi, TFunctionName, TChain, TChainOverride>
+  >
+  uninstallFilter: (
+    args: UninstallFilterParameters,
+  ) => Promise<UninstallFilterReturnType>
+  waitForTransactionReceipt: (
+    args: WaitForTransactionReceiptParameters<TChain>,
+  ) => Promise<WaitForTransactionReceiptReturnType<TChain>>
+  watchBlockNumber: (
+    args: WatchBlockNumberParameters,
+  ) => WatchBlockNumberReturnType
+  watchBlocks: (
+    args: WatchBlocksParameters<TTransport, TChain>,
+  ) => WatchBlocksReturnType
+  watchContractEvent: <
+    TAbi extends Abi | readonly unknown[],
+    TEventName extends string,
+  >(
+    args: WatchContractEventParameters<TAbi, TEventName>,
+  ) => WatchContractEventReturnType
+  watchEvent: <TAbiEvent extends AbiEvent | undefined>(
+    args: WatchEventParameters<TAbiEvent>,
+  ) => WatchEventReturnType
+  watchPendingTransactions: (
+    args: WatchPendingTransactionsParameters<TTransport>,
+  ) => WatchPendingTransactionsReturnType
+}
+
+export const publicActions: <
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+>(
+  client: PublicClient<TTransport, TChain>,
+) => PublicActions<TTransport, TChain> = <
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+>(
+  client: PublicClient<TTransport, TChain>,
+): PublicActions<TTransport, TChain> => ({
+  call: (args) => call(client, args),
+  createBlockFilter: () => createBlockFilter(client),
+  createContractEventFilter: (args) => createContractEventFilter(client, args),
+  createEventFilter: (args) => createEventFilter(client, args),
+  createPendingTransactionFilter: () => createPendingTransactionFilter(client),
+  estimateContractGas: (args) => estimateContractGas(client, args),
+  estimateGas: (args) => estimateGas(client, args),
+  getBalance: (args) => getBalance(client, args),
+  getBlock: (args) => getBlock(client, args),
+  getBlockNumber: (args) => getBlockNumber(client, args),
+  getBlockTransactionCount: (args) => getBlockTransactionCount(client, args),
+  getBytecode: (args) => getBytecode(client, args),
+  getChainId: () => getChainId(client),
+  getEnsAddress: (args) => getEnsAddress(client, args),
+  getEnsAvatar: (args) => getEnsAvatar(client, args),
+  getEnsName: (args) => getEnsName(client, args),
+  getEnsResolver: (args) => getEnsResolver(client, args),
+  getEnsText: (args) => getEnsText(client, args),
+  getFeeHistory: (args) => getFeeHistory(client, args),
+  getFilterChanges: (args) => getFilterChanges(client, args),
+  getFilterLogs: (args) => getFilterLogs(client, args),
+  getGasPrice: () => getGasPrice(client),
+  getLogs: (args) => getLogs(client, args),
+  getStorageAt: (args) => getStorageAt(client, args),
+  getTransaction: (args) => getTransaction(client, args),
+  getTransactionConfirmations: (args) =>
+    getTransactionConfirmations(client, args),
+  getTransactionCount: (args) => getTransactionCount(client, args),
+  getTransactionReceipt: (args) => getTransactionReceipt(client, args),
+  multicall: (args) => multicall(client, args),
+  readContract: (args) => readContract(client, args),
+  simulateContract: (args) => simulateContract(client, args),
+  uninstallFilter: (args) => uninstallFilter(client, args),
+  waitForTransactionReceipt: (args) => waitForTransactionReceipt(client, args),
+  watchBlocks: (args) => watchBlocks(client, args),
+  watchBlockNumber: (args) => watchBlockNumber(client, args),
+  watchContractEvent: (args) => watchContractEvent(client, args),
+  watchEvent: (args) => watchEvent(client, args),
+  watchPendingTransactions: (args) => watchPendingTransactions(client, args),
+})