viem 2.0.0-alpha.9 → 2.0.0-beta.1

package/clients/createClient.ts

@@ -1,6 +1,9 @@
 import type { Address } from 'abitype'
 
-import type { Account, JsonRpcAccount } from '../accounts/types.js'
+import type { JsonRpcAccount } from '../accounts/types.js'
+import type { ParseAccountErrorType } from '../accounts/utils/parseAccount.js'
+import type { ErrorType } from '../errors/utils.js'
+import type { Account } from '../types/account.js'
 import type { Chain } from '../types/chain.js'
 import type {
   EIP1193RequestFn,
@@ -10,6 +13,8 @@ import type {
 import type { Prettify } from '../types/utils.js'
 import { parseAccount } from '../utils/accounts.js'
 import { uid } from '../utils/uid.js'
+import type { PublicActions } from './decorators/public.js'
+import type { WalletActions } from './decorators/wallet.js'
 import type { Transport } from './transports/createTransport.js'
 
 export type ClientConfig<
@@ -51,6 +56,38 @@ export type ClientConfig<
   type?: string | undefined
 }
 
+// Actions that are used internally by other Actions (ie. `call` is used by `readContract`).
+// They are allowed to be extended, but must conform to their parameter & return type interfaces.
+// Example: an extended `call` action must accept `CallParameters` as parameters,
+// and conform to the `CallReturnType` return type.
+type ExtendableProtectedActions = Pick<
+  PublicActions,
+  | 'call'
+  | 'createContractEventFilter'
+  | 'createEventFilter'
+  | 'estimateContractGas'
+  | 'estimateGas'
+  | 'getBlock'
+  | 'getBlockNumber'
+  | 'getChainId'
+  | 'getContractEvents'
+  | 'getEnsText'
+  | 'getFilterChanges'
+  | 'getGasPrice'
+  | 'getLogs'
+  | 'getTransaction'
+  | 'getTransactionCount'
+  | 'getTransactionReceipt'
+  | 'prepareTransactionRequest'
+  | 'readContract'
+  | 'sendRawTransaction'
+  | 'simulateContract'
+  | 'uninstallFilter'
+  | 'watchBlockNumber'
+  | 'watchContractEvent'
+> &
+  Pick<WalletActions, 'sendTransaction' | 'writeContract'>
+
 // 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<
@@ -61,7 +98,9 @@ export type Client<
   extended extends Extended | undefined = Extended | undefined,
 > = Client_Base<transport, chain, account, rpcSchema> &
   (extended extends Extended ? extended : unknown) & {
-    extend: <const client extends Extended>(
+    extend: <
+      const client extends Extended & Partial<ExtendableProtectedActions>,
+    >(
       fn: (
         client: Client<transport, chain, account, rpcSchema, extended>,
       ) => client,
@@ -120,6 +159,8 @@ export type MulticallBatchOptions = {
   wait?: number | undefined
 }
 
+export type CreateClientErrorType = ParseAccountErrorType | ErrorType
+
 /**
  * Creates a base client with the given transport.
  */

package/clients/createPublicClient.ts

@@ -1,7 +1,13 @@
+import type { ErrorType } from '../errors/utils.js'
 import type { Chain } from '../types/chain.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 Client,
+  type ClientConfig,
+  type CreateClientErrorType,
+  createClient,
+} from './createClient.js'
 import { type PublicActions, publicActions } from './decorators/public.js'
 import type { Transport } from './transports/createTransport.js'
 
@@ -34,6 +40,8 @@ export type PublicClient<
   >
 >
 
+export type CreatePublicClientErrorType = CreateClientErrorType | ErrorType
+
 /**
  * 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).
  *

package/clients/createTestClient.ts

@@ -1,11 +1,17 @@
 import type { Address } from 'abitype'
 
 import type { Account } from '../accounts/types.js'
+import type { ErrorType } from '../errors/utils.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 Client,
+  type ClientConfig,
+  type CreateClientErrorType,
+  createClient,
+} from './createClient.js'
 import { type TestActions, testActions } from './decorators/test.js'
 import type { Transport } from './transports/createTransport.js'
 
@@ -51,6 +57,8 @@ export type TestClient<
   >
 >
 
+export type CreateTestClientErrorType = CreateClientErrorType | ErrorType
+
 /**
  * @description Creates a test client with a given transport.
  */

package/clients/createWalletClient.ts

@@ -1,11 +1,17 @@
 import type { Address } from 'abitype'
 
 import type { Account } from '../accounts/types.js'
+import type { ErrorType } from '../errors/utils.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'
-import { type Client, type ClientConfig, createClient } from './createClient.js'
+import {
+  type Client,
+  type ClientConfig,
+  type CreateClientErrorType,
+  createClient,
+} from './createClient.js'
 import { type WalletActions, walletActions } from './decorators/wallet.js'
 import type { Transport } from './transports/createTransport.js'
 
@@ -43,6 +49,8 @@ export type WalletClient<
   >
 >
 
+export type CreateWalletClientErrorType = CreateClientErrorType | ErrorType
+
 /**
  * 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).
  *

package/clients/decorators/public.ts

@@ -1,4 +1,4 @@
-import type { Abi, AbiEvent } from 'abitype'
+import type { Abi, AbiEvent, Address } from 'abitype'
 
 import {
   type GetEnsAddressParameters,
@@ -97,6 +97,11 @@ import {
   type GetChainIdReturnType,
   getChainId,
 } from '../../actions/public/getChainId.js'
+import {
+  type GetContractEventsParameters,
+  type GetContractEventsReturnType,
+  getContractEvents,
+} from '../../actions/public/getContractEvents.js'
 import {
   type GetFeeHistoryParameters,
   type GetFeeHistoryReturnType,
@@ -121,6 +126,11 @@ import {
   type GetLogsReturnType,
   getLogs,
 } from '../../actions/public/getLogs.js'
+import {
+  type GetProofParameters,
+  type GetProofReturnType,
+  getProof,
+} from '../../actions/public/getProof.js'
 import {
   type GetStorageAtParameters,
   type GetStorageAtReturnType,
@@ -624,6 +634,48 @@ export type PublicActions<
    * // 1
    */
   getChainId: () => Promise<GetChainIdReturnType>
+  /**
+   * Returns a list of event logs emitted by a contract.
+   *
+   * - Docs: https://viem.sh/docs/actions/public/getContractEvents.html
+   * - JSON-RPC Methods: [`eth_getLogs`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getlogs)
+   *
+   * @param client - Client to use
+   * @param parameters - {@link GetContractEventsParameters}
+   * @returns A list of event logs. {@link GetContractEventsReturnType}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   * import { wagmiAbi } from './abi'
+   *
+   * const client = createPublicClient({
+   *   chain: mainnet,
+   *   transport: http(),
+   * })
+   * const logs = await client.getContractEvents(client, {
+   *  address: '0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2',
+   *  abi: wagmiAbi,
+   *  eventName: 'Transfer'
+   * })
+   */
+  getContractEvents: <
+    const abi extends Abi | readonly unknown[],
+    eventName extends ContractEventName<abi> | undefined = undefined,
+    strict extends boolean | undefined = undefined,
+    fromBlock extends BlockNumber | BlockTag | undefined = undefined,
+    toBlock extends BlockNumber | BlockTag | undefined = undefined,
+  >(
+    args: GetContractEventsParameters<
+      abi,
+      eventName,
+      strict,
+      fromBlock,
+      toBlock
+    >,
+  ) => Promise<
+    GetContractEventsReturnType<abi, eventName, strict, fromBlock, toBlock>
+  >
   /**
    * Gets address for ENS name.
    *
@@ -820,7 +872,7 @@ export type PublicActions<
    * // { maxFeePerGas: ..., maxPriorityFeePerGas: ... }
    */
   estimateFeesPerGas: <
-    TChainOverride extends Chain | undefined,
+    TChainOverride extends Chain | undefined = undefined,
     TType extends FeeValuesType = 'eip1559',
   >(
     args?: EstimateFeesPerGasParameters<TChain, TChainOverride, TType>,
@@ -1031,6 +1083,31 @@ export type PublicActions<
   ) => Promise<
     GetLogsReturnType<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>
   >
+  /**
+   * Returns the account and storage values of the specified account including the Merkle-proof.
+   *
+   * - Docs: https://viem.sh/docs/actions/public/getProof.html
+   * - JSON-RPC Methods:
+   *   - Calls [`eth_getProof`](https://eips.ethereum.org/EIPS/eip-1186)
+   *
+   * @param client - Client to use
+   * @param parameters - {@link GetProofParameters}
+   * @returns Proof data. {@link GetProofReturnType}
+   *
+   * @example
+   * import { createPublicClient, http } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   *
+   * const client = createPublicClient({
+   *   chain: mainnet,
+   *   transport: http(),
+   * })
+   * const block = await client.getProof({
+   *  address: '0x...',
+   *  storageKeys: ['0x...'],
+   * })
+   */
+  getProof: (args: GetProofParameters) => Promise<GetProofReturnType>
   /**
    * Returns an estimate for the max priority fee per gas (in wei) for a transaction
    * to be included in the next block.
@@ -1051,7 +1128,9 @@ export type PublicActions<
    * const maxPriorityFeePerGas = await client.estimateMaxPriorityFeePerGas()
    * // 10000000n
    */
-  estimateMaxPriorityFeePerGas: <TChainOverride extends Chain | undefined,>(
+  estimateMaxPriorityFeePerGas: <
+    TChainOverride extends Chain | undefined = undefined,
+  >(
     args?: EstimateMaxPriorityFeePerGasParameters<TChain, TChainOverride>,
   ) => Promise<EstimateMaxPriorityFeePerGasReturnType>
   /**
@@ -1260,7 +1339,9 @@ export type PublicActions<
    *   value: 1n,
    * })
    */
-  prepareTransactionRequest: <TChainOverride extends Chain | undefined,>(
+  prepareTransactionRequest: <
+    TChainOverride extends Chain | undefined = undefined,
+  >(
     args: PrepareTransactionRequestParameters<TChain, TAccount, TChainOverride>,
   ) => Promise<PrepareTransactionRequestReturnType>
   /**
@@ -1366,17 +1447,27 @@ export type PublicActions<
       'nonpayable' | 'payable',
       functionName
     >,
-    TChainOverride extends Chain | undefined,
+    chainOverride extends Chain | undefined,
+    accountOverride extends Account | Address | undefined = undefined,
   >(
     args: SimulateContractParameters<
       abi,
       functionName,
       args,
       TChain,
-      TChainOverride
+      chainOverride,
+      accountOverride
     >,
   ) => Promise<
-    SimulateContractReturnType<abi, functionName, args, TChain, TChainOverride>
+    SimulateContractReturnType<
+      abi,
+      functionName,
+      args,
+      TChain,
+      TAccount,
+      chainOverride,
+      accountOverride
+    >
   >
   verifyMessage: (
     args: VerifyMessageParameters,
@@ -1645,6 +1736,7 @@ export function publicActions<
     getBlockTransactionCount: (args) => getBlockTransactionCount(client, args),
     getBytecode: (args) => getBytecode(client, args),
     getChainId: () => getChainId(client),
+    getContractEvents: (args) => getContractEvents(client, args),
     getEnsAddress: (args) => getEnsAddress(client, args),
     getEnsAvatar: (args) => getEnsAvatar(client, args),
     getEnsName: (args) => getEnsName(client, args),
@@ -1656,6 +1748,7 @@ export function publicActions<
     getFilterLogs: (args) => getFilterLogs(client, args),
     getGasPrice: () => getGasPrice(client),
     getLogs: (args) => getLogs(client, args as any),
+    getProof: (args) => getProof(client, args),
     estimateMaxPriorityFeePerGas: (args) =>
       estimateMaxPriorityFeePerGas(client, args),
     getStorageAt: (args) => getStorageAt(client, args),

package/clients/decorators/wallet.ts

@@ -232,7 +232,7 @@ export type WalletActions<
    *   value: 1n,
    * })
    */
-  prepareTransactionRequest: <TChainOverride extends Chain | undefined,>(
+  prepareTransactionRequest: <TChainOverride extends Chain | undefined>(
     args: PrepareTransactionRequestParameters<TChain, TAccount, TChainOverride>,
   ) => Promise<PrepareTransactionRequestReturnType>
   /**
@@ -443,7 +443,7 @@ export type WalletActions<
    * })
    * const signature = await client.signTransaction(request)
    */
-  signTransaction: <TChainOverride extends Chain | undefined,>(
+  signTransaction: <TChainOverride extends Chain | undefined>(
     args: SignTransactionParameters<TChain, TAccount, TChainOverride>,
   ) => Promise<SignTransactionReturnType>
   /**

package/clients/transports/createTransport.ts

@@ -1,3 +1,4 @@
+import type { ErrorType } from '../../errors/utils.js'
 import type { Chain } from '../../types/chain.js'
 import type { EIP1193RequestFn } from '../../types/eip1193.js'
 import { buildRequest } from '../../utils/buildRequest.js'
@@ -40,6 +41,8 @@ export type Transport<
   value?: TRpcAttributes
 }
 
+export type CreateTransportErrorType = ErrorType
+
 /**
  * @description Creates an transport intended to be used with a client.
  */

package/clients/transports/custom.ts

@@ -1,4 +1,6 @@
+import type { ErrorType } from '../../errors/utils.js'
 import {
+  type CreateTransportErrorType,
   type Transport,
   type TransportConfig,
   createTransport,
@@ -23,6 +25,8 @@ export type CustomTransport = Transport<
   EthereumProvider['request']
 >
 
+export type CustomTransportErrorType = CreateTransportErrorType | ErrorType
+
 /**
  * @description Creates a custom transport given an EIP-1193 compliant `request` attribute.
  */

package/clients/transports/fallback.ts

@@ -1,8 +1,10 @@
+import type { ErrorType } from '../../errors/utils.js'
 import type { Chain } from '../../types/chain.js'
 import { isDeterministicError } from '../../utils/buildRequest.js'
 import { wait } from '../../utils/wait.js'
 
 import {
+  type CreateTransportErrorType,
   type Transport,
   type TransportConfig,
   createTransport,
@@ -81,6 +83,8 @@ export type FallbackTransport = Transport<
   }
 >
 
+export type FallbackTransportErrorType = CreateTransportErrorType | ErrorType
+
 export function fallback(
   transports_: Transport[],
   config: FallbackTransportConfig = {},

package/clients/transports/http.ts

@@ -1,9 +1,14 @@
 import { RpcRequestError } from '../../errors/request.js'
-import { UrlRequiredError } from '../../errors/transport.js'
+import {
+  UrlRequiredError,
+  type UrlRequiredErrorType,
+} from '../../errors/transport.js'
+import type { ErrorType } from '../../errors/utils.js'
 import { createBatchScheduler } from '../../utils/promise/createBatchScheduler.js'
 import { type HttpOptions, type RpcRequest, rpc } from '../../utils/rpc.js'
 
 import {
+  type CreateTransportErrorType,
   type Transport,
   type TransportConfig,
   createTransport,
@@ -42,10 +47,16 @@ export type HttpTransportConfig = {
 export type HttpTransport = Transport<
   'http',
   {
+    fetchOptions?: HttpTransportConfig['fetchOptions']
     url?: string
   }
 >
 
+export type HttpTransportErrorType =
+  | CreateTransportErrorType
+  | UrlRequiredErrorType
+  | ErrorType
+
 /**
  * @description Creates a HTTP transport that connects to a JSON-RPC API.
  */
@@ -87,6 +98,7 @@ export function http(
                 fetchOptions,
                 timeout,
               }),
+            sort: (a, b) => a.id - b.id,
           })
 
           const fn = async (body: RpcRequest) =>
@@ -109,6 +121,7 @@ export function http(
         type: 'http',
       },
       {
+        fetchOptions,
         url,
       },
     )

package/clients/transports/webSocket.ts

@@ -1,10 +1,13 @@
-import type { WebSocket } from 'isomorphic-ws'
-
 import { RpcRequestError } from '../../errors/request.js'
-import { UrlRequiredError } from '../../errors/transport.js'
+import {
+  UrlRequiredError,
+  type UrlRequiredErrorType,
+} from '../../errors/transport.js'
+import type { ErrorType } from '../../errors/utils.js'
 import type { Hash } from '../../types/misc.js'
 import { type RpcResponse, getSocket, rpc } from '../../utils/rpc.js'
 import {
+  type CreateTransportErrorType,
   type Transport,
   type TransportConfig,
   createTransport,
@@ -53,6 +56,11 @@ export type WebSocketTransport = Transport<
   }
 >
 
+export type WebSocketTransportErrorType =
+  | CreateTransportErrorType
+  | UrlRequiredErrorType
+  | ErrorType
+
 /**
  * @description Creates a WebSocket transport that connects to a JSON-RPC API.
  */

package/ens/index.ts

@@ -1,28 +1,33 @@
-export { normalize } from '../utils/ens/normalize.js'
+export { type NormalizeErrorType, normalize } from '../utils/ens/normalize.js'
 export {
+  type GetEnsAddressErrorType,
   type GetEnsAddressParameters,
   type GetEnsAddressReturnType,
   getEnsAddress,
 } from '../actions/ens/getEnsAddress.js'
 export {
+  type GetEnsAvatarErrorType,
   type GetEnsAvatarParameters,
   type GetEnsAvatarReturnType,
   getEnsAvatar,
 } from '../actions/ens/getEnsAvatar.js'
 export {
+  type GetEnsNameErrorType,
   type GetEnsNameParameters,
   type GetEnsNameReturnType,
   getEnsName,
 } from '../actions/ens/getEnsName.js'
 export {
+  type GetEnsResolverErrorType,
   type GetEnsResolverParameters,
   type GetEnsResolverReturnType,
   getEnsResolver,
 } from '../actions/ens/getEnsResolver.js'
 export {
+  type GetEnsTextErrorType,
   type GetEnsTextParameters,
   type GetEnsTextReturnType,
   getEnsText,
 } from '../actions/ens/getEnsText.js'
-export { labelhash } from '../utils/ens/labelhash.js'
-export { namehash } from '../utils/ens/namehash.js'
+export { type LabelhashErrorType, labelhash } from '../utils/ens/labelhash.js'
+export { type NamehashErrorType, namehash } from '../utils/ens/namehash.js'