viem 0.0.0-main.20230708T001525 → 0.0.0-main.20230708T044110

package/src/clients/createClient.ts

@@ -1,7 +1,6 @@
-import type { Address, Narrow } from 'abitype'
+import type { Address } from 'abitype'
 
 import type { Account, JsonRpcAccount } from '../accounts/types.js'
-import type { ParseAccount } from '../types/account.js'
 import type { Chain } from '../types/chain.js'
 import type {
   EIP1193RequestFn,
@@ -13,60 +12,82 @@ import { parseAccount } from '../utils/accounts.js'
 import { uid } from '../utils/uid.js'
 import type { Transport } from './transports/createTransport.js'
 
-export type MulticallBatchOptions = {
-  /** The maximum size (in bytes) for each calldata chunk. @default 1_024 */
-  batchSize?: number
-  /** The maximum number of milliseconds to wait before sending a batch. @default 0 */
-  wait?: number
-}
-
 export type ClientConfig<
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
-  TAccountOrAddress extends Account | Address | undefined =
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends Account | Address | undefined =
     | Account
     | Address
     | undefined,
 > = {
   /** The Account to use for the Client. This will be used for Actions that require an account as an argument. */
-  account?: TAccountOrAddress
+  account?: accountOrAddress extends Account | Address
+    ? accountOrAddress | Account | Address // `accountOrAddress` defined, add for inference
+    : Account | Address | undefined // `accountOrAddress` undefined, show possible types for autocomplete
   /** Flags for batch settings. */
-  batch?: {
-    /** Toggle to enable `eth_call` multicall aggregation. */
-    multicall?: boolean | MulticallBatchOptions
-  }
+  batch?:
+    | {
+        /** Toggle to enable `eth_call` multicall aggregation. */
+        multicall?: boolean | Prettify<MulticallBatchOptions> | undefined
+      }
+    | undefined
   /** Chain for the client. */
-  chain?: TChain
+  chain?: chain extends Chain
+    ? chain // `chain` defined, add for inference
+    : Chain | undefined // `chain` undefined, show possible types for autocomplete
   /** A key for the client. */
-  key?: string
+  key?: string | undefined
   /** A name for the client. */
-  name?: string
+  name?: string | undefined
   /**
    * Frequency (in ms) for polling enabled actions & events.
    * @default 4_000
    */
-  pollingInterval?: number
+  pollingInterval?: number | undefined
   /** The RPC transport */
-  transport: TTransport
+  transport: transport
   /** The type of client. */
-  type?: string
+  type?: string | undefined
 }
 
+// TODO: Move `transport` to slot index 2 since `chain` and `account` used more frequently.
+// Otherwise, we end up with a lot of `Client<Transport, chain, account>` in actions.
+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,
+> = Prettify<
+  Prettify<Client_Base<transport, chain, account, rpcSchema>> & {
+    extend: <const client extends Extended>(
+      fn: (
+        client: Client<transport, chain, account, rpcSchema, extended>,
+      ) => client,
+    ) => Prettify<
+      Client<
+        transport,
+        chain,
+        account,
+        rpcSchema,
+        Prettify<client> & (extended extends Extended ? extended : unknown)
+      >
+    >
+  } & (extended extends Extended ? extended : unknown)
+>
+
 type Client_Base<
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
-  TAccount extends Account | undefined = Account | undefined,
-  TRpcSchema extends RpcSchema | undefined = undefined,
+  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: TAccount
+  account: account
   /** Flags for batch settings. */
-  batch?: {
-    /** Toggle to enable `eth_call` multicall aggregation. */
-    multicall?: boolean | MulticallBatchOptions
-  }
+  batch?: ClientConfig['batch']
   /** Chain for the client. */
-  chain: TChain
+  chain: chain
   /** A key for the client. */
   key: string
   /** A name for the client. */
@@ -74,86 +95,89 @@ type Client_Base<
   /** Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. */
   pollingInterval: number
   /** Request function wrapped with friendly error handling */
-  request: TRpcSchema extends undefined
-    ? EIP1193RequestFn<EIP1474Methods>
-    : EIP1193RequestFn<TRpcSchema>
+  request: EIP1193RequestFn<
+    rpcSchema extends undefined ? EIP1474Methods : rpcSchema
+  >
   /** The RPC transport */
-  transport: ReturnType<TTransport>['config'] & ReturnType<TTransport>['value']
+  transport: ReturnType<transport>['config'] & ReturnType<transport>['value']
   /** The type of client. */
   type: string
   /** A unique ID for the client. */
   uid: string
 }
 
-type Extended = { [K in keyof Client_Base]?: undefined } & {
-  [key: string]: unknown
-}
+type Extended = Prettify<
+  // disallow redefining base properties
+  { [K in keyof Client_Base]?: undefined } & {
+    [key: string]: unknown
+  }
+>
 
-export type Client<
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
-  TAccount extends Account | undefined = Account | undefined,
-  TRpcSchema extends RpcSchema | undefined = undefined,
-  TExtended extends Extended | undefined = Extended | undefined,
-> = Client_Base<TTransport, TChain, TAccount, TRpcSchema> & {
-  extend: <TNextExtended extends Extended = Extended>(
-    fn: (
-      client: Client<TTransport, TChain, TAccount, TRpcSchema, TExtended>,
-    ) => Narrow<TNextExtended>,
-  ) => Client<
-    TTransport,
-    TChain,
-    TAccount,
-    TRpcSchema,
-    (TExtended extends Extended ? TExtended : {}) & TNextExtended
-  >
-} & (TExtended extends Extended ? TExtended : {})
+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
+}
 
 /**
- * @description Creates a base client with the given transport.
+ * Creates a base client with the given transport.
  */
 export function createClient<
-  TTransport extends Transport,
-  TChain extends Chain | undefined = undefined,
-  TAccountOrAddress extends Account | Address | undefined = undefined,
->({
-  account,
-  batch,
-  chain,
-  key = 'base',
-  name = 'Base Client',
-  pollingInterval = 4_000,
+  transport extends Transport,
+  chain extends Chain | undefined = undefined,
+  accountOrAddress extends Account | Address | undefined = undefined,
+>(
+  parameters: ClientConfig<transport, chain, accountOrAddress>,
+): Client<
   transport,
-  type = 'base',
-}: ClientConfig<TTransport, TChain, TAccountOrAddress>): Client<
-  TTransport,
-  TChain,
-  TAccountOrAddress extends Address
-    ? Prettify<JsonRpcAccount<TAccountOrAddress>>
-    : TAccountOrAddress
-> {
-  const { config, request, value } = transport({ chain, pollingInterval })
+  chain,
+  accountOrAddress extends Address
+    ? Prettify<JsonRpcAccount<accountOrAddress>>
+    : accountOrAddress
+>
+
+export function createClient(parameters: ClientConfig): Client {
+  const {
+    batch,
+    key = 'base',
+    name = 'Base Client',
+    pollingInterval = 4_000,
+    type = 'base',
+  } = parameters
+
+  const chain = parameters.chain
+  const account = parameters.account
+    ? parseAccount(parameters.account)
+    : undefined
+  const { config, request, value } = parameters.transport({
+    chain,
+    pollingInterval,
+  })
+  const transport = { ...config, ...value }
+
   const client = {
-    account: (account
-      ? parseAccount(account)
-      : undefined) as ParseAccount<TAccountOrAddress>,
+    account,
     batch,
-    chain: chain as TChain,
+    chain,
     key,
     name,
     pollingInterval,
     request,
-    transport: { ...config, ...value },
+    transport,
     type,
     uid: uid(),
   }
-  function extend(client_: typeof client) {
-    return (fn: (_: typeof client) => unknown) => {
-      const extended = fn(client_) as Extended
+
+  function extend(base: typeof client) {
+    type ExtendFn = (base: typeof client) => unknown
+    return (extendFn: ExtendFn) => {
+      const extended = extendFn(base) as Extended
       for (const key in client) delete extended[key]
-      const nextClient = { ...client_, ...extended }
-      return Object.assign(nextClient, { extend: extend(nextClient) })
+      const combined = { ...base, ...extended }
+      return Object.assign(combined, { extend: extend(combined) })
     }
   }
+
   return Object.assign(client, { extend: extend(client) as any })
 }

package/src/clients/createPublicClient.ts

@@ -6,23 +6,25 @@ import { type PublicActions, publicActions } from './decorators/public.js'
 import type { Transport } from './transports/createTransport.js'
 
 export type PublicClientConfig<
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
-> = Pick<
-  ClientConfig<TTransport, TChain>,
-  'batch' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+> = Prettify<
+  Pick<
+    ClientConfig<transport, chain>,
+    'batch' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+  >
 >
 
 export type PublicClient<
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
 > = Prettify<
   Client<
-    TTransport,
-    TChain,
+    transport,
+    chain,
     undefined,
     PublicRpcSchema,
-    PublicActions<TTransport, TChain>
+    PublicActions<transport, chain>
   >
 >
 
@@ -46,23 +48,21 @@ export type PublicClient<
  * })
  */
 export function createPublicClient<
-  TTransport extends Transport,
-  TChain extends Chain | undefined = undefined,
->({
-  batch,
-  chain,
-  key = 'public',
-  name = 'Public Client',
-  transport,
-  pollingInterval,
-}: PublicClientConfig<TTransport, TChain>): PublicClient<TTransport, TChain> {
-  return createClient({
-    batch,
-    chain,
+  transport extends Transport,
+  chain extends Chain | undefined = undefined,
+>(
+  parameters: PublicClientConfig<transport, chain>,
+): PublicClient<transport, chain>
+
+export function createPublicClient(
+  parameters: PublicClientConfig,
+): PublicClient {
+  const { key = 'public', name = 'Public Client' } = parameters
+  const client = createClient({
+    ...parameters,
     key,
     name,
-    pollingInterval,
-    transport,
     type: 'publicClient',
-  }).extend(publicActions)
+  })
+  return client.extend(publicActions)
 }

package/src/clients/createTestClient.ts

@@ -2,6 +2,7 @@ import type { Account } from '../accounts/types.js'
 import type { ParseAccount } from '../types/account.js'
 import type { Chain } from '../types/chain.js'
 import type { TestRpcSchema } from '../types/eip1193.js'
+import type { Prettify } from '../types/utils.js'
 import { type Client, type ClientConfig, createClient } from './createClient.js'
 import { type TestActions, testActions } from './decorators/test.js'
 import type { Transport } from './transports/createTransport.js'
@@ -10,36 +11,38 @@ import type { Address } from 'abitype'
 export type TestClientMode = 'anvil' | 'hardhat' | 'ganache'
 
 export type TestClientConfig<
-  TMode extends TestClientMode = TestClientMode,
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
-  TAccountOrAddress extends Account | Address | undefined =
+  mode extends TestClientMode = TestClientMode,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends Account | Address | undefined =
     | Account
     | Address
     | undefined,
-> = Pick<
-  ClientConfig<TTransport, TChain, TAccountOrAddress>,
-  'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
-> & {
-  /** Mode of the test client. Available: "anvil" | "hardhat" | "ganache" */
-  mode: TMode
-}
+> = Prettify<
+  Pick<
+    ClientConfig<transport, chain, accountOrAddress>,
+    'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+  > & {
+    /** Mode of the test client. */
+    mode: mode | ('anvil' | 'hardhat' | 'ganache') // TODO: Type utility that expands `TestClientMode`
+  }
+>
 
 export type TestClient<
   TMode extends TestClientMode = TestClientMode,
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
   TAccount extends Account | undefined = Account | undefined,
   TIncludeActions extends boolean = true,
-> = Client<
-  TTransport,
-  TChain,
-  TAccount,
-  TestRpcSchema<TMode>,
-  TIncludeActions extends true ? TestActions : Record<string, unknown>
-> & {
-  mode: TMode
-}
+> = Prettify<
+  { mode: TMode } & Client<
+    transport,
+    chain,
+    TAccount,
+    TestRpcSchema<TMode>,
+    TIncludeActions extends true ? TestActions : Record<string, unknown>
+  >
+>
 
 /**
  * @description Creates a test client with a given transport.
@@ -65,33 +68,24 @@ export type TestClient<
  * })
  */
 export function createTestClient<
-  TMode extends TestClientMode,
-  TTransport extends Transport,
-  TChain extends Chain | undefined = undefined,
-  TAccountOrAddress extends Account | Address | undefined = undefined,
->({
-  account,
-  chain,
-  key = 'test',
-  name = 'Test Client',
-  mode,
-  pollingInterval,
-  transport,
-}: TestClientConfig<TMode, TTransport, TChain, TAccountOrAddress>): TestClient<
-  TMode,
-  TTransport,
-  TChain,
-  ParseAccount<TAccountOrAddress>
-> {
-  return createClient({
-    account,
-    chain,
+  mode extends 'anvil' | 'hardhat' | 'ganache', // TODO: Type utility that expands `TestClientMode`
+  transport extends Transport,
+  chain extends Chain | undefined = undefined,
+  accountOrAddress extends Account | Address | undefined = undefined,
+>(
+  parameters: TestClientConfig<mode, transport, chain, accountOrAddress>,
+): TestClient<mode, transport, chain, ParseAccount<accountOrAddress>>
+
+export function createTestClient(parameters: TestClientConfig): TestClient {
+  const { key = 'test', name = 'Test Client', mode } = parameters
+  const client = createClient({
+    ...parameters,
     key,
     name,
-    pollingInterval,
-    transport,
     type: 'testClient',
   })
-    .extend(() => ({ mode }))
-    .extend(testActions({ mode }))
+  return client.extend((config) => ({
+    mode,
+    ...testActions({ mode })(config),
+  }))
 }

package/src/clients/createWalletClient.ts

@@ -10,28 +10,30 @@ import { type WalletActions, walletActions } from './decorators/wallet.js'
 import type { Transport } from './transports/createTransport.js'
 
 export type WalletClientConfig<
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
-  TAccountOrAddress extends Account | Address | undefined =
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends Account | Address | undefined =
     | Account
     | Address
     | undefined,
-> = Pick<
-  ClientConfig<TTransport, TChain, TAccountOrAddress>,
-  'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+> = Prettify<
+  Pick<
+    ClientConfig<transport, chain, accountOrAddress>,
+    'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
+  >
 >
 
 export type WalletClient<
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
-  TAccount extends Account | undefined = Account | undefined,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
 > = Prettify<
   Client<
-    TTransport,
-    TChain,
-    TAccount,
+    transport,
+    chain,
+    account,
     WalletRpcSchema,
-    WalletActions<TChain, TAccount>
+    WalletActions<chain, account>
   >
 >
 
@@ -72,28 +74,23 @@ export type WalletClient<
  * })
  */
 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,
-  ParseAccount<TAccountOrAddress>
-> {
-  return createClient({
-    account,
-    chain,
+  transport extends Transport,
+  chain extends Chain | undefined = undefined,
+  accountOrAddress extends Account | Address | undefined = undefined,
+>(
+  parameters: WalletClientConfig<transport, chain, accountOrAddress>,
+): WalletClient<transport, chain, ParseAccount<accountOrAddress>>
+
+export function createWalletClient(
+  parameters: WalletClientConfig,
+): WalletClient {
+  const { key = 'wallet', name = 'Wallet Client', transport } = parameters
+  const client = createClient({
+    ...parameters,
     key,
     name,
-    pollingInterval,
     transport: (opts) => transport({ ...opts, retryCount: 0 }),
     type: 'walletClient',
-  }).extend(walletActions)
+  })
+  return client.extend(walletActions)
 }

package/src/clients/decorators/public.ts

@@ -1374,52 +1374,57 @@ export type PublicActions<
   ) => WatchPendingTransactionsReturnType
 }
 
-export const publicActions = <
+export function publicActions<
   TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,
   TAccount extends Account | undefined = Account | undefined,
 >(
   client: Client<TTransport, TChain, TAccount>,
-): PublicActions<TTransport, TChain, TAccount> => ({
-  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 as any),
-  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),
-  verifyMessage: (args) => verifyMessage(client, args),
-  verifyTypedData: (args) => verifyTypedData(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),
-})
+): PublicActions<TTransport, TChain, TAccount> {
+  return {
+    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 as any),
+    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),
+    verifyMessage: (args) => verifyMessage(client, args),
+    verifyTypedData: (args) => verifyTypedData(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),
+  }
+}