viem 0.0.0-portable-types-20230522163654 → 0.0.0-refactor-generics-20230831161903

package/src/clients/createPublicClient.ts

@@ -1,44 +1,41 @@
 import type { Chain } from '../types/chain.js'
-import type { PublicRequests } from '../types/eip1193.js'
+import type { PublicRpcSchema } from '../types/eip1193.js'
 import type { Prettify } from '../types/utils.js'
-
 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 16 */
-  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
-  }
-}
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+> = Prettify<
+  Pick<
+    ClientConfig<transport, chain>,
+    | 'batch'
+    | 'cacheTime'
+    | 'chain'
+    | 'key'
+    | 'name'
+    | 'pollingInterval'
+    | 'transport'
+  >
+>
 
 export type PublicClient<
-  TTransport extends Transport = Transport,
-  TChain extends Chain | undefined = Chain | undefined,
-  TIncludeActions extends boolean = true,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
 > = Prettify<
-  Client<TTransport, PublicRequests, TChain> &
-    Pick<PublicClientConfig, 'batch'> &
-    (TIncludeActions extends true ? PublicActions<TTransport, TChain> : unknown)
+  Client<
+    transport,
+    chain,
+    undefined,
+    PublicRpcSchema,
+    PublicActions<transport, chain>
+  >
 >
 
 /**
- * Creates a Public Client with a given [Transport](https://viem.sh/docs/clients/intro) configured for a [Chain](https://viem.sh/docs/clients/chains).
+ * Creates a Public Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
  *
  * - Docs: https://viem.sh/docs/clients/public.html
  *
@@ -57,33 +54,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,
-  true
-> {
-  const client = {
-    batch,
-    ...(createClient({
-      chain,
-      key,
-      name,
-      pollingInterval,
-      transport,
-      type: 'publicClient',
-    }) as PublicClient<TTransport, TChain>),
-  }
-  return {
-    ...client,
-    ...publicActions(client),
-  }
+  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,
+    type: 'publicClient',
+  })
+  return client.extend(publicActions)
 }

package/src/clients/createTestClient.ts

@@ -1,6 +1,10 @@
-import type { Chain } from '../types/chain.js'
-import type { TestRequests } from '../types/eip1193.js'
+import type { Address } from 'abitype'
 
+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'
@@ -8,36 +12,54 @@ import type { Transport } from './transports/createTransport.js'
 export type TestClientMode = 'anvil' | 'hardhat' | 'ganache'
 
 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" | "ganache" */
-  mode: TMode
-}
+  mode extends TestClientMode = TestClientMode,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends Account | Address | undefined =
+    | Account
+    | Address
+    | undefined,
+> = Prettify<
+  Pick<
+    ClientConfig<transport, chain, accountOrAddress>,
+    | 'account'
+    | 'cacheTime'
+    | '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, TestRequests<TMode>, TChain> &
-  (TIncludeActions extends true ? TestActions : 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.
  */
 /**
- * Creates a Test Client with a given [Transport](https://viem.sh/docs/clients/intro) configured for a [Chain](https://viem.sh/docs/clients/chains).
+ * Creates a Test Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
  *
  * - Docs: https://viem.sh/docs/clients/test.html
  *
- * A Test Client is an interface to "test" JSON-RPC API methods accessible through a local Ethereum test node such as [Anvil](https://book.getfoundry.sh/anvil/) or [Hardhat](https://hardhat.org/) such as mining blocks, impersonating accounts, setting fees, etc through [Test Actions](https://viem.sh/docs/actions/test/introduction).
+ * A Test Client is an interface to "test" JSON-RPC API methods accessible through a local Ethereum test node such as [Anvil](https://book.getfoundry.sh/anvil/) or [Hardhat](https://hardhat.org/) such as mining blocks, impersonating accounts, setting fees, etc through [Test Actions](https://viem.sh/docs/actions/test/introduction.html).
  *
  * @param config - {@link TestClientConfig}
  * @returns A Test Client. {@link TestClient}
@@ -53,35 +75,24 @@ export type TestClient<
  * })
  */
 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 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,
+    type: 'testClient',
+  })
+  return client.extend((config) => ({
     mode,
-  } as TestClient<TMode, TTransport, TChain>
-  return {
-    ...client,
-    ...testActions(client),
-  }
+    ...testActions({ mode })(config),
+  }))
 }

package/src/clients/createWalletClient.ts

@@ -1,51 +1,54 @@
 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 { Requests } from '../types/eip1193.js'
+import type { WalletRpcSchema } from '../types/eip1193.js'
 import type { Prettify } from '../types/utils.js'
-
 import { type Client, type ClientConfig, createClient } from './createClient.js'
 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>,
-  '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
-}
+> = Prettify<
+  Pick<
+    ClientConfig<transport, chain, accountOrAddress>,
+    | 'account'
+    | 'cacheTime'
+    | '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,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
 > = Prettify<
-  Client<TTransport, Requests, TChain> &
-    (TIncludeActions extends true
-      ? WalletActions<TChain, TAccount>
-      : unknown) & {
-      /** The Account to use for the Wallet Client. */
-      account: TAccount
-    }
+  Client<
+    transport,
+    chain,
+    account,
+    WalletRpcSchema,
+    WalletActions<chain, account>
+  >
 >
 
 /**
- * Creates a Wallet Client with a given [Transport](https://viem.sh/docs/clients/intro) configured for a [Chain](https://viem.sh/docs/clients/chains).
+ * Creates a Wallet Client with a given [Transport](https://viem.sh/docs/clients/intro.html) configured for a [Chain](https://viem.sh/docs/clients/chains.html).
  *
  * - Docs: https://viem.sh/docs/clients/wallet.html
  *
- * A Wallet Client is an interface to interact with [Ethereum Account(s)](https://ethereum.org/en/glossary/#account) and provides the ability to retrieve accounts, execute transactions, sign messages, etc. through [Wallet Actions](https://viem.sh/docs/actions/wallet/introduction).
+ * A Wallet Client is an interface to interact with [Ethereum Account(s)](https://ethereum.org/en/glossary/#account) and provides the ability to retrieve accounts, execute transactions, sign messages, etc. through [Wallet Actions](https://viem.sh/docs/actions/wallet/introduction.html).
  *
  * The Wallet Client supports signing over:
  * - [JSON-RPC Accounts](https://viem.sh/docs/clients/wallet.html#json-rpc-accounts) (e.g. Browser Extension Wallets, WalletConnect, etc).
@@ -77,43 +80,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,
-  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),
-  }
+  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,
+    transport: (opts) => transport({ ...opts, retryCount: 0 }),
+    type: 'walletClient',
+  })
+  return client.extend(walletActions)
 }