viem 1.1.7 → 1.2.0

package/src/clients/createClient.ts

@@ -1,16 +1,40 @@
+import type { Address, Narrow } 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,
   EIP1474Methods,
   RpcSchema,
 } from '../types/eip1193.js'
+import type { Prettify } from '../types/utils.js'
+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 =
+    | 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
+  /** Flags for batch settings. */
+  batch?: {
+    /** Toggle to enable `eth_call` multicall aggregation. */
+    multicall?: boolean | MulticallBatchOptions
+  }
   /** Chain for the client. */
   chain?: TChain
   /** A key for the client. */
@@ -28,11 +52,19 @@ export type ClientConfig<
   type?: string
 }
 
-export type Client<
+type Client_Base<
   TTransport extends Transport = Transport,
-  TRpcSchema extends RpcSchema | undefined = undefined,
   TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends Account | undefined = Account | undefined,
+  TRpcSchema extends RpcSchema | undefined = undefined,
 > = {
+  /** The Account of the Client. */
+  account: TAccount
+  /** Flags for batch settings. */
+  batch?: {
+    /** Toggle to enable `eth_call` multicall aggregation. */
+    multicall?: boolean | MulticallBatchOptions
+  }
   /** Chain for the client. */
   chain: TChain
   /** A key for the client. */
@@ -53,30 +85,75 @@ export type Client<
   uid: string
 }
 
+type Extended = { [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 : {})
+
 /**
  * @description Creates a base client with the given transport.
  */
 export function createClient<
   TTransport extends Transport,
-  TRpcSchema extends RpcSchema | undefined = undefined,
   TChain extends Chain | undefined = undefined,
+  TAccountOrAddress extends Account | Address | undefined = undefined,
 >({
+  account,
+  batch,
   chain,
   key = 'base',
   name = 'Base Client',
   pollingInterval = 4_000,
   transport,
   type = 'base',
-}: ClientConfig<TTransport, TChain>): Client<TTransport, TRpcSchema, TChain> {
+}: ClientConfig<TTransport, TChain, TAccountOrAddress>): Client<
+  TTransport,
+  TChain,
+  TAccountOrAddress extends Address
+    ? Prettify<JsonRpcAccount<TAccountOrAddress>>
+    : TAccountOrAddress
+> {
   const { config, request, value } = transport({ chain, pollingInterval })
-  return {
+  const client = {
+    account: (account
+      ? parseAccount(account)
+      : undefined) as ParseAccount<TAccountOrAddress>,
+    batch,
     chain: chain as TChain,
     key,
     name,
     pollingInterval,
-    request: request as any,
+    request,
     transport: { ...config, ...value },
     type,
     uid: uid(),
   }
+  function extend(client_: typeof client) {
+    return (fn: (_: typeof client) => unknown) => {
+      const extended = fn(client_) as Extended
+      for (const key in client) delete extended[key]
+      const nextClient = { ...client_, ...extended }
+      return Object.assign(nextClient, { extend: extend(nextClient) })
+    }
+  }
+  return Object.assign(client, { extend: extend(client) as any })
 }

package/src/clients/createPublicClient.ts

@@ -5,35 +5,25 @@ import { type Client, type ClientConfig, createClient } from './createClient.js'
 import { type PublicActions, publicActions } from './decorators/public.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 PublicClientConfig<
   TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,
 > = Pick<
   ClientConfig<TTransport, TChain>,
-  'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
-> & {
-  /** Flags for batch settings. */
-  batch?: {
-    /** Toggle to enable `eth_call` multicall aggregation. */
-    multicall?: boolean | MulticallBatchOptions
-  }
-}
+  'batch' | '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, PublicRpcSchema, TChain> &
-    Pick<PublicClientConfig, 'batch'> &
-    (TIncludeActions extends true ? PublicActions<TTransport, TChain> : unknown)
+  Client<
+    TTransport,
+    TChain,
+    undefined,
+    PublicRpcSchema,
+    PublicActions<TTransport, TChain>
+  >
 >
 
 /**
@@ -65,24 +55,14 @@ export function createPublicClient<
   name = 'Public Client',
   transport,
   pollingInterval,
-}: PublicClientConfig<TTransport, TChain>): PublicClient<
-  TTransport,
-  TChain,
-  true
-> {
-  const client = {
+}: PublicClientConfig<TTransport, TChain>): PublicClient<TTransport, TChain> {
+  return createClient({
     batch,
-    ...(createClient({
-      chain,
-      key,
-      name,
-      pollingInterval,
-      transport,
-      type: 'publicClient',
-    }) as PublicClient<TTransport, TChain>),
-  }
-  return {
-    ...client,
-    ...publicActions(client),
-  }
+    chain,
+    key,
+    name,
+    pollingInterval,
+    transport,
+    type: 'publicClient',
+  }).extend(publicActions)
 }

package/src/clients/createTestClient.ts

@@ -1,8 +1,11 @@
+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 Client, type ClientConfig, createClient } from './createClient.js'
 import { type TestActions, testActions } from './decorators/test.js'
 import type { Transport } from './transports/createTransport.js'
+import type { Address } from 'abitype'
 
 export type TestClientMode = 'anvil' | 'hardhat' | 'ganache'
 
@@ -10,9 +13,13 @@ export type TestClientConfig<
   TMode extends TestClientMode = TestClientMode,
   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'
+  ClientConfig<TTransport, TChain, TAccountOrAddress>,
+  'account' | 'chain' | 'key' | 'name' | 'pollingInterval' | 'transport'
 > & {
   /** Mode of the test client. Available: "anvil" | "hardhat" | "ganache" */
   mode: TMode
@@ -22,11 +29,17 @@ export type TestClient<
   TMode extends TestClientMode = TestClientMode,
   TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends Account | undefined = Account | undefined,
   TIncludeActions extends boolean = true,
-> = Client<TTransport, TestRpcSchema<TMode>, TChain> &
-  (TIncludeActions extends true ? TestActions : unknown) & {
-    mode: TMode
-  }
+> = Client<
+  TTransport,
+  TChain,
+  TAccount,
+  TestRpcSchema<TMode>,
+  TIncludeActions extends true ? TestActions : Record<string, unknown>
+> & {
+  mode: TMode
+}
 
 /**
  * @description Creates a test client with a given transport.
@@ -55,32 +68,30 @@ 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>): TestClient<
+}: TestClientConfig<TMode, TTransport, TChain, TAccountOrAddress>): TestClient<
   TMode,
   TTransport,
   TChain,
-  true
+  ParseAccount<TAccountOrAddress>
 > {
-  const client = {
-    ...createClient({
-      chain,
-      key,
-      name,
-      pollingInterval,
-      transport,
-      type: 'testClient',
-    }),
-    mode,
-  } as TestClient<TMode, TTransport, TChain>
-  return {
-    ...client,
-    ...testActions(client),
-  }
+  return createClient({
+    account,
+    chain,
+    key,
+    name,
+    pollingInterval,
+    transport,
+    type: 'testClient',
+  })
+    .extend(() => ({ mode }))
+    .extend(testActions({ mode }))
 }

package/src/clients/createWalletClient.ts

@@ -1,7 +1,7 @@
 import type { Address } from 'abitype'
 
-import type { Account, JsonRpcAccount } from '../accounts/types.js'
-import { parseAccount } from '../accounts/utils/parseAccount.js'
+import type { Account } from '../accounts/types.js'
+import type { ParseAccount } from '../types/account.js'
 import type { Chain } from '../types/chain.js'
 import type { WalletRpcSchema } from '../types/eip1193.js'
 import type { Prettify } from '../types/utils.js'
@@ -17,26 +17,22 @@ export type WalletClientConfig<
     | 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
-}
+  ClientConfig<TTransport, TChain, TAccountOrAddress>,
+  '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,
-  TIncludeActions extends boolean = true,
 > = Prettify<
-  Client<TTransport, WalletRpcSchema, TChain> &
-    (TIncludeActions extends true
-      ? WalletActions<TChain, TAccount>
-      : unknown) & {
-      /** The Account to use for the Wallet Client. */
-      account: TAccount
-    }
+  Client<
+    TTransport,
+    TChain,
+    TAccount,
+    WalletRpcSchema,
+    WalletActions<TChain, TAccount>
+  >
 >
 
 /**
@@ -89,30 +85,15 @@ export function createWalletClient<
 }: WalletClientConfig<TTransport, TChain, TAccountOrAddress>): WalletClient<
   TTransport,
   TChain,
-  TAccountOrAddress extends Address
-    ? Prettify<JsonRpcAccount<TAccountOrAddress>>
-    : TAccountOrAddress,
-  true
+  ParseAccount<TAccountOrAddress>
 > {
-  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),
-  }
+  return createClient({
+    account,
+    chain,
+    key,
+    name,
+    pollingInterval,
+    transport: (opts) => transport({ ...opts, retryCount: 0 }),
+    type: 'walletClient',
+  }).extend(walletActions)
 }

package/src/clients/decorators/public.ts

@@ -196,6 +196,7 @@ import {
   type WatchPendingTransactionsReturnType,
   watchPendingTransactions,
 } from '../../actions/public/watchPendingTransactions.js'
+import type { Account } from '../../types/account.js'
 import type { Chain } from '../../types/chain.js'
 import type {
   ContractFunctionConfig,
@@ -203,12 +204,13 @@ import type {
   MaybeExtractEventArgsFromAbi,
 } from '../../types/contract.js'
 import type { FilterType } from '../../types/filter.js'
-import type { PublicClient } from '../createPublicClient.js'
+import type { Client } from '../createClient.js'
 import type { Transport } from '../transports/createTransport.js'
 
 export type PublicActions<
   TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends Account | undefined = Account | undefined,
 > = {
   /**
    * Executes a new message call immediately without submitting a transaction to the network.
@@ -375,7 +377,7 @@ export type PublicActions<
     TAbi extends Abi | readonly unknown[],
     TFunctionName extends string,
   >(
-    args: EstimateContractGasParameters<TAbi, TFunctionName, TChain>,
+    args: EstimateContractGasParameters<TAbi, TFunctionName, TChain, TAccount>,
   ) => Promise<EstimateContractGasReturnType>
   /**
    * Estimates the gas necessary to complete a transaction without submitting it to the network.
@@ -401,7 +403,7 @@ export type PublicActions<
    * })
    */
   estimateGas: (
-    args: EstimateGasParameters<TChain>,
+    args: EstimateGasParameters<TChain, TAccount>,
   ) => Promise<EstimateGasReturnType>
   /**
    * Returns the balance of an address in wei.
@@ -1372,23 +1374,19 @@ export type PublicActions<
   ) => WatchPendingTransactionsReturnType
 }
 
-export const publicActions: <
+export const publicActions = <
   TTransport extends Transport = Transport,
   TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends Account | undefined = Account | 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> => ({
+  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),
+  estimateContractGas: (args) => estimateContractGas(client, args as any),
   estimateGas: (args) => estimateGas(client, args),
   getBalance: (args) => getBalance(client, args),
   getBlock: (args) => getBlock(client, args),

package/src/clients/decorators/test.ts

@@ -84,9 +84,11 @@ import {
   type StopImpersonatingAccountParameters,
   stopImpersonatingAccount,
 } from '../../actions/test/stopImpersonatingAccount.js'
+import type { Account } from '../../types/account.js'
 import type { Chain } from '../../types/chain.js'
 import type { Quantity } from '../../types/rpc.js'
-import type { TestClient, TestClientMode } from '../createTestClient.js'
+import type { Client } from '../createClient.js'
+import type { TestClientMode } from '../createTestClient.js'
 import type { Transport } from '../transports/createTransport.js'
 
 export type TestActions = {
@@ -666,40 +668,58 @@ export type TestActions = {
   ) => Promise<void>
 }
 
-export function testActions<TChain extends Chain | undefined>(
-  client: TestClient<TestClientMode, Transport, TChain>,
-): TestActions {
-  return {
-    dropTransaction: (args) => dropTransaction(client, args),
-    getAutomine: () => getAutomine(client),
-    getTxpoolContent: () => getTxpoolContent(client),
-    getTxpoolStatus: () => getTxpoolStatus(client),
-    impersonateAccount: (args) => impersonateAccount(client, args),
-    increaseTime: (args) => increaseTime(client, args),
-    inspectTxpool: () => inspectTxpool(client),
-    mine: (args) => mine(client, args),
-    removeBlockTimestampInterval: () => removeBlockTimestampInterval(client),
-    reset: (args) => reset(client, args),
-    revert: (args) => revert(client, args),
-    sendUnsignedTransaction: (args) =>
-      sendUnsignedTransaction(client, args as any),
-    setAutomine: (args) => setAutomine(client, args),
-    setBalance: (args) => setBalance(client, args),
-    setBlockGasLimit: (args) => setBlockGasLimit(client, args),
-    setBlockTimestampInterval: (args) =>
-      setBlockTimestampInterval(client, args),
-    setCode: (args) => setCode(client, args),
-    setCoinbase: (args) => setCoinbase(client, args),
-    setIntervalMining: (args) => setIntervalMining(client, args),
-    setLoggingEnabled: (args) => setLoggingEnabled(client, args),
-    setMinGasPrice: (args) => setMinGasPrice(client, args),
-    setNextBlockBaseFeePerGas: (args) =>
-      setNextBlockBaseFeePerGas(client, args),
-    setNextBlockTimestamp: (args) => setNextBlockTimestamp(client, args),
-    setNonce: (args) => setNonce(client, args),
-    setRpcUrl: (args) => setRpcUrl(client, args),
-    setStorageAt: (args) => setStorageAt(client, args),
-    snapshot: () => snapshot(client),
-    stopImpersonatingAccount: (args) => stopImpersonatingAccount(client, args),
+export function testActions<TMode extends TestClientMode>({
+  mode,
+}: { mode: TMode }): <
+  TTransport extends Transport = Transport,
+  TChain extends Chain | undefined = Chain | undefined,
+  TAccount extends Account | undefined = Account | undefined,
+>(
+  client: Client<TTransport, TChain, TAccount>,
+) => TestActions {
+  return <
+    TTransport extends Transport = Transport,
+    TChain extends Chain | undefined = Chain | undefined,
+    TAccount extends Account | undefined = Account | undefined,
+  >(
+    client_: Client<TTransport, TChain, TAccount>,
+  ): TestActions => {
+    const client = client_.extend(() => ({
+      mode,
+    }))
+    return {
+      dropTransaction: (args) => dropTransaction(client, args),
+      getAutomine: () => getAutomine(client),
+      getTxpoolContent: () => getTxpoolContent(client),
+      getTxpoolStatus: () => getTxpoolStatus(client),
+      impersonateAccount: (args) => impersonateAccount(client, args),
+      increaseTime: (args) => increaseTime(client, args),
+      inspectTxpool: () => inspectTxpool(client),
+      mine: (args) => mine(client, args),
+      removeBlockTimestampInterval: () => removeBlockTimestampInterval(client),
+      reset: (args) => reset(client, args),
+      revert: (args) => revert(client, args),
+      sendUnsignedTransaction: (args) =>
+        sendUnsignedTransaction(client, args as any),
+      setAutomine: (args) => setAutomine(client, args),
+      setBalance: (args) => setBalance(client, args),
+      setBlockGasLimit: (args) => setBlockGasLimit(client, args),
+      setBlockTimestampInterval: (args) =>
+        setBlockTimestampInterval(client, args),
+      setCode: (args) => setCode(client, args),
+      setCoinbase: (args) => setCoinbase(client, args),
+      setIntervalMining: (args) => setIntervalMining(client, args),
+      setLoggingEnabled: (args) => setLoggingEnabled(client, args),
+      setMinGasPrice: (args) => setMinGasPrice(client, args),
+      setNextBlockBaseFeePerGas: (args) =>
+        setNextBlockBaseFeePerGas(client, args),
+      setNextBlockTimestamp: (args) => setNextBlockTimestamp(client, args),
+      setNonce: (args) => setNonce(client, args),
+      setRpcUrl: (args) => setRpcUrl(client, args),
+      setStorageAt: (args) => setStorageAt(client, args),
+      snapshot: () => snapshot(client),
+      stopImpersonatingAccount: (args) =>
+        stopImpersonatingAccount(client, args),
+    }
   }
 }

package/src/clients/decorators/wallet.ts

@@ -61,7 +61,7 @@ import {
   writeContract,
 } from '../../actions/wallet/writeContract.js'
 import type { Chain } from '../../types/chain.js'
-import type { WalletClient } from '../createWalletClient.js'
+import type { Client } from '../createClient.js'
 import type { Transport } from '../transports/createTransport.js'
 
 export type WalletActions<
@@ -523,18 +523,12 @@ export type WalletActions<
   ) => Promise<WriteContractReturnType>
 }
 
-export const walletActions: <
+export const walletActions = <
   TTransport extends Transport,
   TChain extends Chain | undefined = Chain | undefined,
   TAccount extends Account | undefined = Account | undefined,
 >(
-  client: WalletClient<TTransport, TChain, TAccount>,
-) => WalletActions<TChain, TAccount> = <
-  TTransport extends Transport,
-  TChain extends Chain | undefined = Chain | undefined,
-  TAccount extends Account | undefined = Account | undefined,
->(
-  client: WalletClient<TTransport, TChain, TAccount>,
+  client: Client<TTransport, TChain, TAccount>,
 ): WalletActions<TChain, TAccount> => ({
   addChain: (args) => addChain(client, args),
   deployContract: (args) => deployContract(client, args),