viem 1.1.8 → 1.2.0

package/src/actions/wallet/addChain.ts

@@ -1,5 +1,5 @@
 import type { Account } from '../../accounts/types.js'
-import type { WalletClient } from '../../clients/createWalletClient.js'
+import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { Chain } from '../../types/chain.js'
 import { numberToHex } from '../../utils/encoding/toHex.js'
@@ -31,10 +31,7 @@ export type AddChainParameters = {
 export async function addChain<
   TChain extends Chain | undefined,
   TAccount extends Account | undefined,
->(
-  client: WalletClient<Transport, TChain, TAccount>,
-  { chain }: AddChainParameters,
-) {
+>(client: Client<Transport, TChain, TAccount>, { chain }: AddChainParameters) {
   const { id, name, nativeCurrency, rpcUrls, blockExplorers } = chain
   await client.request({
     method: 'wallet_addEthereumChain',

package/src/actions/wallet/deployContract.ts

@@ -1,7 +1,7 @@
 import type { Abi, Narrow } from 'abitype'
 
 import type { Account } from '../../accounts/types.js'
-import type { WalletClient } from '../../clients/createWalletClient.js'
+import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { Chain, GetChain } from '../../types/chain.js'
 import type { GetConstructorArgs } from '../../types/contract.js'
@@ -63,7 +63,7 @@ export function deployContract<
   TAccount extends Account | undefined,
   TChainOverride extends Chain | undefined,
 >(
-  walletClient: WalletClient<Transport, TChain, TAccount>,
+  walletClient: Client<Transport, TChain, TAccount>,
   {
     abi,
     args,

package/src/actions/wallet/getAddresses.ts

@@ -1,7 +1,7 @@
 import type { Address } from 'abitype'
 
 import type { Account } from '../../accounts/types.js'
-import type { WalletClient } from '../../clients/createWalletClient.js'
+import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { Chain } from '../../types/chain.js'
 import { checksumAddress } from '../../utils/address/getAddress.js'
@@ -32,7 +32,7 @@ export async function getAddresses<
   TChain extends Chain | undefined,
   TAccount extends Account | undefined = undefined,
 >(
-  client: WalletClient<Transport, TChain, TAccount>,
+  client: Client<Transport, TChain, TAccount>,
 ): Promise<GetAddressesReturnType> {
   const addresses = await client.request({ method: 'eth_accounts' })
   return addresses.map((address) => checksumAddress(address))

package/src/actions/wallet/getPermissions.ts

@@ -1,5 +1,5 @@
 import type { Account } from '../../accounts/types.js'
-import type { WalletClient } from '../../clients/createWalletClient.js'
+import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { Chain } from '../../types/chain.js'
 import type { WalletPermission } from '../../types/eip1193.js'
@@ -29,7 +29,7 @@ export type GetPermissionsReturnType = WalletPermission[]
 export async function getPermissions<
   TChain extends Chain | undefined,
   TAccount extends Account | undefined = undefined,
->(client: WalletClient<Transport, TChain, TAccount>) {
+>(client: Client<Transport, TChain, TAccount>) {
   const permissions = await client.request({ method: 'wallet_getPermissions' })
   return permissions
 }

package/src/actions/wallet/requestAddresses.ts

@@ -1,7 +1,7 @@
 import type { Address } from 'abitype'
 
 import type { Account } from '../../accounts/types.js'
-import type { WalletClient } from '../../clients/createWalletClient.js'
+import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { Chain } from '../../types/chain.js'
 import { getAddress } from '../../utils/address/getAddress.js'
@@ -36,7 +36,7 @@ export async function requestAddresses<
   TChain extends Chain | undefined,
   TAccount extends Account | undefined = undefined,
 >(
-  client: WalletClient<Transport, TChain, TAccount>,
+  client: Client<Transport, TChain, TAccount>,
 ): Promise<RequestAddressesReturnType> {
   const addresses = await client.request({ method: 'eth_requestAccounts' })
   return addresses.map((address) => getAddress(address))

package/src/actions/wallet/requestPermissions.ts

@@ -1,5 +1,5 @@
 import type { Account } from '../../accounts/types.js'
-import type { WalletClient } from '../../clients/createWalletClient.js'
+import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { Chain } from '../../types/chain.js'
 import type { WalletPermission } from '../../types/eip1193.js'
@@ -41,7 +41,7 @@ export async function requestPermissions<
   TChain extends Chain | undefined,
   TAccount extends Account | undefined = undefined,
 >(
-  client: WalletClient<Transport, TChain, TAccount>,
+  client: Client<Transport, TChain, TAccount>,
   permissions: RequestPermissionsParameters,
 ) {
   return client.request({

package/src/actions/wallet/sendTransaction.ts

@@ -1,6 +1,6 @@
 import type { Account } from '../../accounts/types.js'
 import { parseAccount } from '../../accounts/utils/parseAccount.js'
-import type { WalletClient } from '../../clients/createWalletClient.js'
+import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import { AccountNotFoundError } from '../../errors/account.js'
 import type { BaseError } from '../../errors/base.js'
@@ -88,7 +88,7 @@ export async function sendTransaction<
   TAccount extends Account | undefined,
   TChainOverride extends Chain | undefined,
 >(
-  client: WalletClient<Transport, TChain, TAccount>,
+  client: Client<Transport, TChain, TAccount>,
   args: SendTransactionParameters<TChain, TAccount, TChainOverride>,
 ): Promise<SendTransactionReturnType> {
   const {

package/src/actions/wallet/signMessage.ts

@@ -1,6 +1,6 @@
 import type { Account } from '../../accounts/types.js'
 import { parseAccount } from '../../accounts/utils/parseAccount.js'
-import type { WalletClient } from '../../clients/createWalletClient.js'
+import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import { AccountNotFoundError } from '../../errors/account.js'
 import type { GetAccountParameter } from '../../types/account.js'
@@ -66,7 +66,7 @@ export async function signMessage<
   TChain extends Chain | undefined,
   TAccount extends Account | undefined,
 >(
-  client: WalletClient<Transport, TChain, TAccount>,
+  client: Client<Transport, TChain, TAccount>,
   {
     account: account_ = client.account,
     message,

package/src/actions/wallet/signTypedData.ts

@@ -2,7 +2,7 @@ import type { TypedData } from 'abitype'
 
 import type { Account } from '../../accounts/types.js'
 import { parseAccount } from '../../accounts/utils/parseAccount.js'
-import type { WalletClient } from '../../clients/createWalletClient.js'
+import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import { AccountNotFoundError } from '../../errors/account.js'
 import type { GetAccountParameter } from '../../types/account.js'
@@ -126,7 +126,7 @@ export async function signTypedData<
   TChain extends Chain | undefined,
   TAccount extends Account | undefined,
 >(
-  client: WalletClient<Transport, TChain, TAccount>,
+  client: Client<Transport, TChain, TAccount>,
   {
     account: account_ = client.account,
     domain,

package/src/actions/wallet/switchChain.ts

@@ -1,5 +1,5 @@
 import type { Account } from '../../accounts/types.js'
-import type { WalletClient } from '../../clients/createWalletClient.js'
+import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { Chain } from '../../types/chain.js'
 import { numberToHex } from '../../utils/encoding/toHex.js'
@@ -32,10 +32,7 @@ export type SwitchChainParameters = {
 export async function switchChain<
   TChain extends Chain | undefined,
   TAccount extends Account | undefined = undefined,
->(
-  client: WalletClient<Transport, TChain, TAccount>,
-  { id }: SwitchChainParameters,
-) {
+>(client: Client<Transport, TChain, TAccount>, { id }: SwitchChainParameters) {
   await client.request({
     method: 'wallet_switchEthereumChain',
     params: [

package/src/actions/wallet/watchAsset.ts

@@ -1,5 +1,5 @@
 import type { Account } from '../../accounts/types.js'
-import type { WalletClient } from '../../clients/createWalletClient.js'
+import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { Chain } from '../../types/chain.js'
 import type { WatchAssetParams } from '../../types/eip1193.js'
@@ -39,7 +39,7 @@ export async function watchAsset<
   TChain extends Chain | undefined,
   TAccount extends Account | undefined = undefined,
 >(
-  client: WalletClient<Transport, TChain, TAccount>,
+  client: Client<Transport, TChain, TAccount>,
   params: WatchAssetParameters,
 ): Promise<WatchAssetReturnType> {
   const added = await client.request({

package/src/actions/wallet/writeContract.ts

@@ -1,7 +1,7 @@
 import type { Abi } from 'abitype'
 
 import type { Account } from '../../accounts/types.js'
-import type { WalletClient } from '../../clients/createWalletClient.js'
+import type { Client } from '../../clients/createClient.js'
 import type { Transport } from '../../clients/transports/createTransport.js'
 import type { Chain, GetChain } from '../../types/chain.js'
 import type { ContractFunctionConfig, GetValue } from '../../types/contract.js'
@@ -103,7 +103,7 @@ export async function writeContract<
   TFunctionName extends string,
   TChainOverride extends Chain | undefined = undefined,
 >(
-  client: WalletClient<Transport, TChain, TAccount>,
+  client: Client<Transport, TChain, TAccount>,
   {
     abi,
     address,

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)
 }