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

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.0.0-alpha.9",
-  "type": "module",
+  "version": "2.0.0-beta.1",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -12,6 +11,7 @@
     "*",
     "!**/*.tsbuildinfo",
     "!**/*.test.ts",
+    "!**/*.test.ts.snap",
     "!**/*.test-d.ts",
     "!**/*.bench.ts",
     "!tsconfig.build.json"
@@ -22,11 +22,6 @@
       "import": "./_esm/index.js",
       "default": "./_cjs/index.js"
     },
-    "./abi": {
-      "types": "./_types/abi/index.d.ts",
-      "import": "./_esm/abi/index.js",
-      "default": "./_cjs/abi/index.js"
-    },
     "./accounts": {
       "types": "./_types/accounts/index.d.ts",
       "import": "./_esm/accounts/index.js",
@@ -47,36 +42,16 @@
       "import": "./_esm/chains/utils.js",
       "default": "./_cjs/chains/utils.js"
     },
-    "./contract": {
-      "types": "./_types/contract/index.d.ts",
-      "import": "./_esm/contract/index.js",
-      "default": "./_cjs/contract/index.js"
-    },
     "./ens": {
       "types": "./_types/ens/index.d.ts",
       "import": "./_esm/ens/index.js",
       "default": "./_cjs/ens/index.js"
     },
-    "./public": {
-      "types": "./_types/public/index.d.ts",
-      "import": "./_esm/public/index.js",
-      "default": "./_cjs/public/index.js"
-    },
-    "./test": {
-      "types": "./_types/test/index.d.ts",
-      "import": "./_esm/test/index.js",
-      "default": "./_cjs/test/index.js"
-    },
     "./utils": {
       "types": "./_types/utils/index.d.ts",
       "import": "./_esm/utils/index.js",
       "default": "./_cjs/utils/index.js"
     },
-    "./wallet": {
-      "types": "./_types/wallet/index.d.ts",
-      "import": "./_esm/wallet/index.js",
-      "default": "./_cjs/wallet/index.js"
-    },
     "./window": {
       "types": "./_types/window/index.d.ts",
       "import": "./_esm/window/index.js",
@@ -86,18 +61,27 @@
   },
   "typesVersions": {
     "*": {
-      "abi": ["./_types/abi/index.d.ts"],
-      "accounts": ["./_types/accounts/index.d.ts"],
-      "actions": ["./_types/actions/index.d.ts"],
-      "chains": ["./_types/chains/index.d.ts"],
-      "chains/utils": ["./_types/chains/utils.d.ts"],
-      "contract": ["./_types/contract/index.d.ts"],
-      "ens": ["./_types/ens/index.d.ts"],
-      "public": ["./_types/public/index.d.ts"],
-      "test": ["./_types/test/index.d.ts"],
-      "utils": ["./_types/utils/index.d.ts"],
-      "wallet": ["./_types/wallet/index.d.ts"],
-      "window": ["./_types/window/index.d.ts"]
+      "accounts": [
+        "./_types/accounts/index.d.ts"
+      ],
+      "actions": [
+        "./_types/actions/index.d.ts"
+      ],
+      "chains": [
+        "./_types/chains/index.d.ts"
+      ],
+      "chains/utils": [
+        "./_types/chains/utils.d.ts"
+      ],
+      "ens": [
+        "./_types/ens/index.d.ts"
+      ],
+      "utils": [
+        "./_types/utils/index.d.ts"
+      ],
+      "window": [
+        "./_types/window/index.d.ts"
+      ]
     }
   },
   "peerDependencies": {
@@ -114,19 +98,28 @@
     "@noble/hashes": "1.3.2",
     "@scure/bip32": "1.3.2",
     "@scure/bip39": "1.2.1",
-    "@types/ws": "^8.5.5",
-    "abitype": "0.9.8",
-    "isomorphic-ws": "5.0.0",
+    "abitype": "0.10.0",
+    "isows": "1.0.3",
     "ws": "8.13.0"
   },
   "license": "MIT",
+  "homepage": "https://viem.sh",
   "repository": "wagmi-dev/viem",
-  "authors": ["awkweb.eth", "jxom.eth"],
+  "authors": [
+    "awkweb.eth",
+    "jxom.eth"
+  ],
   "funding": [
     {
       "type": "github",
       "url": "https://github.com/sponsors/wagmi-dev"
     }
   ],
-  "keywords": ["eth", "ethereum", "dapps", "wallet", "web3"]
-}
+  "keywords": [
+    "eth",
+    "ethereum",
+    "dapps",
+    "wallet",
+    "web3"
+  ]
+}

package/types/block.ts

@@ -2,6 +2,7 @@ import type { Address } from 'abitype'
 
 import type { Hash, Hex } from './misc.js'
 import type { Transaction } from './transaction.js'
+import type { Withdrawal } from './withdrawal.js'
 
 export type Block<
   TQuantity = bigint,
@@ -56,6 +57,10 @@ export type Block<
   transactionsRoot: Hash
   /** List of uncle hashes */
   uncles: Hash[]
+  /** List of withdrawal objects */
+  withdrawals?: Withdrawal[]
+  /** Root of the this block’s withdrawals trie */
+  withdrawalsRoot?: Hex
 }
 
 export type BlockIdentifier<TQuantity = bigint> = {

package/types/chain.ts

@@ -16,22 +16,12 @@ import type { SerializeTransactionFn } from '../utils/transaction/serializeTrans
 
 export type Chain<
   formatters extends ChainFormatters | undefined = ChainFormatters | undefined,
-> = Prettify<ChainConstants & ChainConfig<formatters>>
-
-/////////////////////////////////////////////////////////////////////
-// Constants
-
-type ChainBlockExplorer = {
-  name: string
-  url: string
-}
-
-type ChainConstants = {
+> = {
   /** Collection of block explorers */
   blockExplorers?:
     | {
+        [key: string]: ChainBlockExplorer
         default: ChainBlockExplorer
-        etherscan?: ChainBlockExplorer | undefined
       }
     | undefined
   /** Collection of contracts */
@@ -53,26 +43,35 @@ type ChainConstants = {
   id: number
   /** Human-readable name */
   name: string
-  /**
-   * Internal network name
-   * @deprecated will be removed in v2 - use `id` instead.
-   */
-  network: string
   /** Currency used by chain */
   nativeCurrency: ChainNativeCurrency
   /** Collection of RPC endpoints */
   rpcUrls: {
     [key: string]: ChainRpcUrls
     default: ChainRpcUrls
-    public: ChainRpcUrls
   }
   /** Source Chain ID (ie. the L1 chain) */
   sourceId?: number | undefined
   /** Flag for test networks */
   testnet?: boolean | undefined
 
-  // TODO(v2): remove `rpcUrls` in favor of `publicRpcUrls`.
-  // publicRpcUrls: ChainRpcUrls,
+  /**
+   * Modifies how chain data structures (ie. Blocks, Transactions, etc)
+   * are formatted & typed.
+   */
+  formatters?: formatters | undefined
+  /** Modifies how data (ie. Transactions) is serialized. */
+  serializers?: ChainSerializers<formatters> | undefined
+  /** Modifies how fees are derived. */
+  fees?: ChainFees<formatters> | undefined
+}
+
+/////////////////////////////////////////////////////////////////////
+// Constants
+
+type ChainBlockExplorer = {
+  name: string
+  url: string
 }
 
 export type ChainContract = {
@@ -95,20 +94,6 @@ type ChainRpcUrls = {
 /////////////////////////////////////////////////////////////////////
 // Config
 
-export type ChainConfig<
-  formatters extends ChainFormatters | undefined = ChainFormatters | undefined,
-> = {
-  /**
-   * Modifies how chain data structures (ie. Blocks, Transactions, etc)
-   * are formatted & typed.
-   */
-  formatters?: formatters | undefined
-  /** Modifies how data (ie. Transactions) is serialized. */
-  serializers?: ChainSerializers<formatters> | undefined
-  /** Modifies how fees are derived. */
-  fees?: ChainFees<formatters> | undefined
-}
-
 export type ChainFees<
   formatters extends ChainFormatters | undefined = ChainFormatters | undefined,
 > = {
@@ -215,6 +200,11 @@ export type ChainEstimateFeesPerGasFnParameters<
 /////////////////////////////////////////////////////////////////////
 // Utils
 
+export type ExtractChain<
+  chains extends readonly Chain[],
+  chainId extends Chain['id'],
+> = Extract<chains[number], { id: chainId }>
+
 export type ExtractChainFormatterExclude<
   chain extends { formatters?: Chain['formatters'] } | undefined,
   type extends keyof ChainFormatters,
@@ -249,4 +239,4 @@ export type GetChain<
   chainOverride extends Chain | undefined = undefined,
 > = IsUndefined<chain> extends true
   ? { chain: chainOverride | null }
-  : { chain?: chainOverride | null }
+  : { chain?: chainOverride | null | undefined }

package/types/contract.ts

@@ -13,7 +13,7 @@ import {
   type ExtractAbiEventNames,
   type ExtractAbiFunction,
   type ExtractAbiFunctionNames,
-  type ResolvedConfig,
+  type ResolvedRegister,
 } from 'abitype'
 
 import type { Hex, LogTopic } from './misc.js'
@@ -25,7 +25,6 @@ import type {
   MaybeRequired,
   NoUndefined,
   Prettify,
-  UnionEvaluate,
   UnionToTuple,
 } from './utils.js'
 
@@ -132,14 +131,14 @@ export type ContractEventArgsFromTopics<
 export type Widen<type> =
   | ([unknown] extends [type] ? unknown : never)
   | (type extends Function ? type : never)
-  | (type extends ResolvedConfig['BigIntType'] ? bigint : never)
+  | (type extends ResolvedRegister['BigIntType'] ? bigint : never)
   | (type extends boolean ? boolean : never)
-  | (type extends ResolvedConfig['IntType'] ? number : never)
+  | (type extends ResolvedRegister['IntType'] ? number : never)
   | (type extends string
-      ? type extends ResolvedConfig['AddressType']
-        ? ResolvedConfig['AddressType']
-        : type extends ResolvedConfig['BytesType']['inputs']
-        ? ResolvedConfig['BytesType']
+      ? type extends ResolvedRegister['AddressType']
+        ? ResolvedRegister['AddressType']
+        : type extends ResolvedRegister['BytesType']['inputs']
+        ? ResolvedRegister['BytesType']
         : string
       : never)
   | (type extends readonly [] ? readonly [] : never)
@@ -205,25 +204,8 @@ export type ContractFunctionParameters<
   functionName:
     | allFunctionNames // show all options
     | (functionName extends allFunctionNames ? functionName : never) // infer value
-} & UnionEvaluate<
-  readonly [] extends allArgs
-    ? {
-        args?:
-          | allArgs // show all options
-          // infer value, widen inferred value of `args` conditionally to match `allArgs`
-          | (abi extends Abi
-              ? args extends allArgs
-                ? Widen<args>
-                : never
-              : never)
-          | undefined
-      }
-    : {
-        args:
-          | allArgs // show all options
-          | (Widen<args> & (args extends allArgs ? unknown : never)) // infer value, widen inferred value of `args` match `allArgs` (e.g. avoid union `args: readonly [123n] | readonly [bigint]`)
-      }
->
+  args?: (abi extends Abi ? Widen<args> : never) | allArgs | undefined
+} & (readonly [] extends allArgs ? {} : { args: Widen<args> })
 
 export type ContractFunctionReturnType<
   abi extends Abi | readonly unknown[] = Abi,

package/types/eip1193.ts

@@ -9,6 +9,7 @@ import type {
   RpcBlockNumber as BlockNumber,
   RpcFeeHistory as FeeHistory,
   RpcLog as Log,
+  RpcProof as Proof,
   RpcTransaction as Transaction,
   RpcTransactionReceipt as TransactionReceipt,
   RpcTransactionRequest as TransactionRequest,
@@ -30,6 +31,9 @@ export type EIP1193Provider = Prettify<
 //////////////////////////////////////////////////
 // Errors
 
+export type ProviderRpcErrorType = ProviderRpcError & {
+  name: 'ProviderRpcError'
+}
 export class ProviderRpcError extends Error {
   code: number
   details: string
@@ -446,6 +450,26 @@ export type PublicRpcSchema = [
     ]
     ReturnType: Log[]
   },
+  /**
+   * @description Returns the account and storage values of the specified account including the Merkle-proof.
+   * @link https://eips.ethereum.org/EIPS/eip-1186
+   * @example
+   * provider.request({ method: 'eth_getProof', params: ['0x...', ['0x...'], 'latest'] })
+   * // => {
+   * //   ...
+   * // }
+   */
+  {
+    Method: 'eth_getProof'
+    Parameters: [
+      /** Address of the account. */
+      address: Address,
+      /** An array of storage-keys that should be proofed and included. */
+      storageKeys: Hash[],
+      block: BlockNumber | BlockTag,
+    ]
+    ReturnType: Proof
+  },
   /**
    * @description Returns the value from a storage position at an address
    * @link https://eips.ethereum.org/EIPS/eip-1474

package/types/misc.ts

@@ -9,10 +9,11 @@ export type SignableMessage =
       raw: Hex | ByteArray
     }
 export type Signature = {
-  // TODO(v2): Make `bigint`
   r: Hex
-  // TODO(v2): Make `bigint`
   s: Hex
-  // TODO(v2): `v` to `recovery`
   v: bigint
 }
+export type CompactSignature = {
+  r: Hex
+  yParityAndS: Hex
+}

package/types/proof.ts

@@ -0,0 +1,20 @@
+import type { Address } from 'abitype'
+import type { Hash } from './misc.js'
+
+export type AccountProof = Hash
+
+export type StorageProof<TQuantity = bigint> = {
+  key: Hash
+  proof: Hash[]
+  value: TQuantity
+}
+
+export type Proof<TQuantity = bigint, TIndex = number> = {
+  address: Address
+  balance: TQuantity
+  codeHash: Hash
+  nonce: TIndex
+  storageHash: Hash
+  accountProof: AccountProof[]
+  storageProof: StorageProof<TQuantity>[]
+}

package/types/rpc.ts

@@ -7,6 +7,7 @@ import type {
 } from './block.js'
 import type { FeeHistory, FeeValues } from './fee.js'
 import type { Log } from './log.js'
+import type { Proof } from './proof.js'
 import type {
   TransactionEIP1559,
   TransactionEIP2930,
@@ -34,6 +35,7 @@ export type RpcUncle = Uncle<Quantity>
 export type RpcFeeHistory = FeeHistory<Quantity>
 export type RpcFeeValues = FeeValues<Quantity>
 export type RpcLog = Log<Quantity, Index>
+export type RpcProof = Proof<Quantity, Index>
 export type RpcTransactionReceipt = TransactionReceipt<
   Quantity,
   Index,

package/types/transaction.ts

@@ -32,7 +32,7 @@ export type TransactionReceipt<
   /** Gas used by this transaction */
   gasUsed: TQuantity
   /** List of log objects generated by this transaction */
-  logs: Log<TQuantity, TIndex>[]
+  logs: Log<TQuantity, TIndex, false>[]
   /** Logs bloom filter */
   logsBloom: Hex
   /** `success` if this transaction was successful or `reverted` if it failed */
@@ -133,7 +133,7 @@ export type TransactionRequestBase<TQuantity = bigint, TIndex = number> = {
   /** Unique number identifying this transaction */
   nonce?: TIndex
   /** Transaction recipient */
-  to?: Address
+  to?: Address | null
   /** Value in wei sent with this transaction */
   value?: TQuantity
 }

package/types/utils.ts

@@ -54,7 +54,7 @@ export type IsNever<T> = [T] extends [never] ? true : false
  * type Result = Or<[false, false, false]>
  * //   ^? type Result = false
  */
-export type Or<T extends readonly unknown[],> = T extends readonly [
+export type Or<T extends readonly unknown[]> = T extends readonly [
   infer Head,
   ...infer Tail,
 ]

package/types/withdrawal.ts

@@ -0,0 +1,8 @@
+import type { Hex } from './misc.js'
+
+export type Withdrawal = {
+  address: Hex
+  amount: Hex
+  index: Hex
+  validatorIndex: Hex
+}

package/utils/abi/decodeAbiParameters.ts

@@ -6,22 +6,36 @@ import type {
 
 import {
   AbiDecodingDataSizeTooSmallError,
+  type AbiDecodingDataSizeTooSmallErrorType,
   AbiDecodingZeroDataError,
+  type AbiDecodingZeroDataErrorType,
   InvalidAbiDecodingTypeError,
+  type InvalidAbiDecodingTypeErrorType,
 } from '../../errors/abi.js'
 import type { Hex } from '../../types/misc.js'
-import { checksumAddress } from '../address/getAddress.js'
-import { size } from '../data/size.js'
-import { slice } from '../data/slice.js'
-import { trim } from '../data/trim.js'
 import {
+  type ChecksumAddressErrorType,
+  checksumAddress,
+} from '../address/getAddress.js'
+import { type SizeErrorType, size } from '../data/size.js'
+import { type SliceErrorType, slice } from '../data/slice.js'
+import { type TrimErrorType, trim } from '../data/trim.js'
+import {
+  type HexToBigIntErrorType,
+  type HexToBoolErrorType,
+  type HexToNumberErrorType,
+  type HexToStringErrorType,
   hexToBigInt,
   hexToBool,
   hexToNumber,
   hexToString,
 } from '../encoding/fromHex.js'
 
-import { getArrayComponents } from './encodeAbiParameters.js'
+import type { ErrorType } from '../../errors/utils.js'
+import {
+  type GetArrayComponentsErrorType,
+  getArrayComponents,
+} from './encodeAbiParameters.js'
 
 export type DecodeAbiParametersReturnType<
   TParams extends
@@ -31,6 +45,13 @@ export type DecodeAbiParametersReturnType<
   TParams extends readonly AbiParameter[] ? TParams : AbiParameter[]
 >
 
+export type DecodeAbiParametersErrorType =
+  | AbiDecodingDataSizeTooSmallErrorType
+  | AbiDecodingZeroDataErrorType
+  | DecodeParamsErrorType
+  | SizeErrorType
+  | ErrorType
+
 export function decodeAbiParameters<
   const TParams extends readonly AbiParameter[] | readonly unknown[],
 >(params: TParams, data: Hex): DecodeAbiParametersReturnType<TParams> {
@@ -52,6 +73,8 @@ export function decodeAbiParameters<
 
 type TupleAbiParameter = AbiParameter & { components: readonly AbiParameter[] }
 
+type DecodeParamsErrorType = DecodeParamErrorType | SizeErrorType | ErrorType
+
 function decodeParams<const TParams extends readonly AbiParameter[]>({
   data,
   params,
@@ -77,6 +100,17 @@ function decodeParams<const TParams extends readonly AbiParameter[]>({
   return decodedValues as unknown as AbiParametersToPrimitiveTypes<TParams>
 }
 
+type DecodeParamErrorType =
+  | DecodeArrayErrorType
+  | DecodeTupleErrorType
+  | DecodeStringErrorType
+  | DecodeBytesErrorType
+  | DecodeNumberErrorType
+  | DecodeAddressErrorType
+  | DecodeBoolErrorType
+  | InvalidAbiDecodingTypeErrorType
+  | ErrorType
+
 function decodeParam({
   data,
   param,
@@ -121,10 +155,17 @@ function decodeParam({
 
 ////////////////////////////////////////////////////////////////////
 
+type DecodeAddressErrorType =
+  | ChecksumAddressErrorType
+  | SliceErrorType
+  | ErrorType
+
 function decodeAddress(value: Hex) {
   return { consumed: 32, value: checksumAddress(slice(value, -20)) }
 }
 
+type DecodeArrayErrorType = HexToNumberErrorType | SliceErrorType | ErrorType
+
 function decodeArray<const TParam extends AbiParameter>(
   data: Hex,
   {
@@ -206,10 +247,14 @@ function decodeArray<const TParam extends AbiParameter>(
   return { value, consumed }
 }
 
+type DecodeBoolErrorType = HexToBoolErrorType | ErrorType
+
 function decodeBool(value: Hex) {
   return { consumed: 32, value: hexToBool(value) }
 }
 
+type DecodeBytesErrorType = HexToNumberErrorType | SliceErrorType | ErrorType
+
 function decodeBytes<const TParam extends AbiParameter>(
   data: Hex,
   { param, position }: { param: TParam; position: number },
@@ -238,6 +283,11 @@ function decodeBytes<const TParam extends AbiParameter>(
   return { consumed: 32, value }
 }
 
+type DecodeNumberErrorType =
+  | HexToBigIntErrorType
+  | HexToNumberErrorType
+  | ErrorType
+
 function decodeNumber<const TParam extends AbiParameter>(
   value: Hex,
   { param }: { param: TParam },
@@ -253,6 +303,13 @@ function decodeNumber<const TParam extends AbiParameter>(
   }
 }
 
+type DecodeStringErrorType =
+  | HexToNumberErrorType
+  | HexToStringErrorType
+  | SliceErrorType
+  | TrimErrorType
+  | ErrorType
+
 function decodeString(data: Hex, { position }: { position: number }) {
   const offset = hexToNumber(
     slice(data, position, position + 32, { strict: true }),
@@ -266,6 +323,12 @@ function decodeString(data: Hex, { position }: { position: number }) {
   return { consumed: 32, value }
 }
 
+type DecodeTupleErrorType =
+  | HasDynamicChildErrorType
+  | HexToNumberErrorType
+  | SliceErrorType
+  | ErrorType
+
 function decodeTuple<
   const TParam extends AbiParameter & { components: readonly AbiParameter[] },
 >(data: Hex, { param, position }: { param: TParam; position: number }) {
@@ -316,6 +379,8 @@ function decodeTuple<
   return { consumed, value }
 }
 
+type HasDynamicChildErrorType = GetArrayComponentsErrorType | ErrorType
+
 function hasDynamicChild(param: AbiParameter) {
   const { type } = param
   if (type === 'string') return true

package/utils/abi/decodeDeployData.ts

@@ -2,12 +2,18 @@ import type { Abi } from 'abitype'
 
 import {
   AbiConstructorNotFoundError,
+  type AbiConstructorNotFoundErrorType,
   AbiConstructorParamsNotFoundError,
+  type AbiConstructorParamsNotFoundErrorType,
 } from '../../errors/abi.js'
 import type { ContractConstructorArgs } from '../../types/contract.js'
 import type { Hex } from '../../types/misc.js'
 
-import { decodeAbiParameters } from './decodeAbiParameters.js'
+import type { ErrorType } from '../../errors/utils.js'
+import {
+  type DecodeAbiParametersErrorType,
+  decodeAbiParameters,
+} from './decodeAbiParameters.js'
 
 const docsPath = '/docs/contract/decodeDeployData'
 
@@ -28,6 +34,12 @@ export type DecodeDeployDataReturnType<
   args: allArgs
 }
 
+export type DecodeDeployDataErrorType =
+  | AbiConstructorNotFoundErrorType
+  | AbiConstructorParamsNotFoundErrorType
+  | DecodeAbiParametersErrorType
+  | ErrorType
+
 export function decodeDeployData<const abi extends Abi | readonly unknown[]>(
   parameters: DecodeDeployDataParameters<abi>,
 ): DecodeDeployDataReturnType<abi> {