viem 2.0.0-beta.0 → 2.0.0-beta.10

package/errors/encoding.ts

@@ -2,36 +2,6 @@ import type { ByteArray, Hex } from '../types/misc.js'
 
 import { BaseError } from './base.js'
 
-export type DataLengthTooLongErrorType = DataLengthTooLongError & {
-  name: 'DataLengthTooLongError'
-}
-/** @deprecated */
-export class DataLengthTooLongError extends BaseError {
-  override name = 'DataLengthTooLongError'
-  constructor({ consumed, length }: { consumed: number; length: number }) {
-    super(
-      `Consumed bytes (${consumed}) is shorter than data length (${
-        length - 1
-      }).`,
-    )
-  }
-}
-
-export type DataLengthTooShortErrorType = DataLengthTooShortError & {
-  name: 'DataLengthTooShortError'
-}
-/** @deprecated */
-export class DataLengthTooShortError extends BaseError {
-  override name = 'DataLengthTooShortError'
-  constructor({ length, dataLength }: { length: number; dataLength: number }) {
-    super(
-      `Data length (${dataLength - 1}) is shorter than consumed bytes length (${
-        length - 1
-      }).`,
-    )
-  }
-}
-
 export type IntegerOutOfRangeErrorType = IntegerOutOfRangeError & {
   name: 'IntegerOutOfRangeError'
 }
@@ -94,19 +64,6 @@ export class InvalidHexValueError extends BaseError {
   }
 }
 
-export type OffsetOutOfBoundsErrorType = OffsetOutOfBoundsError & {
-  name: 'OffsetOutOfBoundsError'
-}
-/** @deprecated */
-export class OffsetOutOfBoundsError extends BaseError {
-  override name = 'OffsetOutOfBoundsError' as const
-  constructor({ nextOffset, offset }: { nextOffset: number; offset: number }) {
-    super(
-      `Next offset (${nextOffset}) is greater than previous offset + consumed bytes (${offset})`,
-    )
-  }
-}
-
 export type SizeOverflowErrorType = SizeOverflowError & {
   name: 'SizeOverflowError'
 }

package/errors/estimateGas.ts

@@ -29,7 +29,7 @@ export class EstimateGasExecutionError extends BaseError {
       nonce,
       to,
       value,
-    }: Omit<EstimateGasParameters<any, any>, 'account'> & {
+    }: Omit<EstimateGasParameters<any>, 'account'> & {
       account?: Account
       chain?: Chain
       docsPath?: string
@@ -40,7 +40,7 @@ export class EstimateGasExecutionError extends BaseError {
       to,
       value:
         typeof value !== 'undefined' &&
-        `${formatEther(value)} ${chain?.nativeCurrency.symbol || 'ETH'}`,
+        `${formatEther(value)} ${chain?.nativeCurrency?.symbol || 'ETH'}`,
       data,
       gas,
       gasPrice:

package/errors/transaction.ts

@@ -174,7 +174,7 @@ export class TransactionExecutionError extends BaseError {
       to,
       value:
         typeof value !== 'undefined' &&
-        `${formatEther(value)} ${chain?.nativeCurrency.symbol || 'ETH'}`,
+        `${formatEther(value)} ${chain?.nativeCurrency?.symbol || 'ETH'}`,
       data,
       gas,
       gasPrice:

package/errors/version.ts

@@ -1 +1 @@
-export const version = '2.0.0-beta.0'
+export const version = '2.0.0-beta.10'

package/index.ts

@@ -232,11 +232,7 @@ export type {
 } from './actions/public/watchBlockNumber.js'
 export type {
   WatchEventOnLogsFn,
-  /** @deprecated - use `WatchEventOnLogsFn` instead. */
-  WatchEventOnLogsFn as OnLogFn,
   WatchEventOnLogsParameter,
-  /** @deprecated - use `WatchEventOnLogsParameter` instead. */
-  WatchEventOnLogsParameter as OnLogParameter,
   WatchEventErrorType,
   WatchEventParameters,
   WatchEventReturnType,
@@ -294,9 +290,8 @@ export type {
 export type {
   PrepareTransactionRequestErrorType,
   PrepareTransactionRequestParameters,
+  PrepareTransactionRequestParameterType,
   PrepareTransactionRequestReturnType,
-  /** @deprecated import `prepareTransactionRequest` from `viem/actions` instead. */
-  prepareTransactionRequest as prepareRequest,
 } from './actions/wallet/prepareTransactionRequest.js'
 export type {
   SendUnsignedTransactionErrorType,
@@ -403,24 +398,13 @@ export type {
   ChainFeesFnParameters,
   ChainFormatter,
   ChainEstimateFeesPerGasFnParameters,
-  GetChain,
-  /** @deprecated use `ChainFormatter` instead. */
-  ChainFormatter as Formatter,
+  DeriveChain,
+  GetChainParameter,
   ChainFormatters,
-  /** @deprecated use `ChainFormatters` instead. */
-  ChainFormatters as Formatters,
   ChainSerializers,
-  /** @deprecated use `ChainSerializers` instead. */
-  ChainSerializers as Serializers,
   ExtractChainFormatterExclude,
-  /** @deprecated use `ExtractChainFormatterExclude` instead. */
-  ExtractChainFormatterExclude as ExtractFormatterExclude,
   ExtractChainFormatterParameters,
-  /** @deprecated use `ExtractChainFormatterParameters` instead. */
-  ExtractChainFormatterParameters as ExtractFormatterParameters,
   ExtractChainFormatterReturnType,
-  /** @deprecated use `ExtractChainFormatterReturnType` instead. */
-  ExtractChainFormatterReturnType as ExtractFormatterReturnType,
 } from './types/chain.js'
 export {
   type Client,
@@ -596,6 +580,8 @@ export {
   minInt248,
   minInt256,
 } from './constants/number.js'
+export { zeroHash } from './constants/bytes.js'
+export { presignMessagePrefix } from './constants/strings.js'
 export {
   AbiConstructorNotFoundError,
   type AbiConstructorNotFoundErrorType,
@@ -731,10 +717,6 @@ export {
   type InvalidChainIdErrorType,
 } from './errors/chain.js'
 export {
-  DataLengthTooLongError,
-  type DataLengthTooLongErrorType,
-  DataLengthTooShortError,
-  type DataLengthTooShortErrorType,
   InvalidBytesBooleanError,
   type InvalidBytesBooleanErrorType,
   IntegerOutOfRangeError,
@@ -743,8 +725,6 @@ export {
   type InvalidHexBooleanErrorType,
   InvalidHexValueError,
   type InvalidHexValueErrorType,
-  OffsetOutOfBoundsError,
-  type OffsetOutOfBoundsErrorType,
   SizeOverflowError,
   type SizeOverflowErrorType,
 } from './errors/encoding.js'
@@ -1211,8 +1191,6 @@ export {
   type BytesToBigIntErrorType,
   type BytesToBigIntOpts,
   bytesToBigInt,
-  /** @deprecated - use `bytesToBigInt` */
-  bytesToBigInt as bytesToBigint,
   type BytesToBoolErrorType,
   type BytesToBoolOpts,
   bytesToBool,

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.10",
+  "type": "module",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -32,6 +33,11 @@
       "import": "./_esm/actions/index.js",
       "default": "./_cjs/actions/index.js"
     },
+    "./celo": {
+      "types": "./_types/chains/celo/index.d.ts",
+      "import": "./_esm/chains/celo/index.js",
+      "default": "./_cjs/chains/celo/index.js"
+    },
     "./chains": {
       "types": "./_types/chains/index.d.ts",
       "import": "./_esm/chains/index.js",
@@ -47,6 +53,11 @@
       "import": "./_esm/ens/index.js",
       "default": "./_cjs/ens/index.js"
     },
+    "./op-stack": {
+      "types": "./_types/chains/opStack/index.d.ts",
+      "import": "./_esm/chains/opStack/index.js",
+      "default": "./_cjs/chains/opStack/index.js"
+    },
     "./utils": {
       "types": "./_types/utils/index.d.ts",
       "import": "./_esm/utils/index.js",
@@ -57,31 +68,22 @@
       "import": "./_esm/window/index.js",
       "default": "./_cjs/window/index.js"
     },
+    "./zksync": {
+      "types": "./_types/chains/zksync/index.d.ts",
+      "import": "./_esm/chains/zksync/index.js",
+      "default": "./_cjs/chains/zksync/index.js"
+    },
     "./package.json": "./package.json"
   },
   "typesVersions": {
     "*": {
-      "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"
-      ]
+      "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": {
@@ -93,7 +95,7 @@
     }
   },
   "dependencies": {
-    "@adraffy/ens-normalize": "1.9.4",
+    "@adraffy/ens-normalize": "1.10.0",
     "@noble/curves": "1.2.0",
     "@noble/hashes": "1.3.2",
     "@scure/bip32": "1.3.2",
@@ -103,22 +105,14 @@
     "ws": "8.13.0"
   },
   "license": "MIT",
-  "repository": "wagmi-dev/viem",
-  "authors": [
-    "awkweb.eth",
-    "jxom.eth"
-  ],
+  "homepage": "https://viem.sh",
+  "repository": "wevm/viem",
+  "authors": ["awkweb.eth", "jxom.eth"],
   "funding": [
     {
       "type": "github",
-      "url": "https://github.com/sponsors/wagmi-dev"
+      "url": "https://github.com/sponsors/wevm"
     }
   ],
-  "keywords": [
-    "eth",
-    "ethereum",
-    "dapps",
-    "wallet",
-    "web3"
-  ]
-}
+  "keywords": ["eth", "ethereum", "dapps", "wallet", "web3"]
+}

package/types/account.ts

@@ -4,11 +4,20 @@ import type { Account, JsonRpcAccount } from '../accounts/types.js'
 
 import type { IsUndefined, Prettify } from './utils.js'
 
+export type DeriveAccount<
+  account extends Account | undefined,
+  accountOverride extends Account | Address | undefined,
+> = accountOverride extends Account ? accountOverride : account
+
 export type GetAccountParameter<
   TAccount extends Account | undefined = Account | undefined,
+  TAccountOverride extends Account | Address | undefined = Account | Address,
+  TRequired extends boolean = true,
 > = IsUndefined<TAccount> extends true
-  ? { account: Account | Address }
-  : { account?: Account | Address }
+  ? TRequired extends true
+    ? { account: TAccountOverride }
+    : { account?: TAccountOverride }
+  : { account?: TAccountOverride }
 
 export type ParseAccount<
   TAccountOrAddress extends Account | Address | undefined =

package/types/chain.ts

@@ -30,7 +30,7 @@ export type Chain<
         {
           [key: string]:
             | ChainContract
-            | { [chainId: number]: ChainContract | undefined }
+            | { [sourceId: number]: ChainContract | undefined }
             | undefined
         } & {
           ensRegistry?: ChainContract | undefined
@@ -63,7 +63,7 @@ export type Chain<
   /** Modifies how data (ie. Transactions) is serialized. */
   serializers?: ChainSerializers<formatters> | undefined
   /** Modifies how fees are derived. */
-  fees?: ChainFees<formatters> | undefined
+  fees?: ChainFees<formatters | undefined> | undefined
 }
 
 /////////////////////////////////////////////////////////////////////
@@ -168,7 +168,9 @@ export type ChainFeesFnParameters<
   formatters extends ChainFormatters | undefined = ChainFormatters | undefined,
 > = {
   /** The latest block. */
-  block: Prettify<FormattedBlock<{ formatters: formatters }>>
+  block: Prettify<
+    FormattedBlock<Omit<Chain, 'formatters'> & { formatters: formatters }>
+  >
   client: Client<Transport, Chain>
   /**
    * A transaction request. This value will be undefined if the caller
@@ -206,7 +208,7 @@ export type ExtractChain<
 > = Extract<chains[number], { id: chainId }>
 
 export type ExtractChainFormatterExclude<
-  chain extends { formatters?: Chain['formatters'] } | undefined,
+  chain extends Chain | undefined,
   type extends keyof ChainFormatters,
 > = chain extends { formatters?: infer _Formatters extends ChainFormatters }
   ? _Formatters[type] extends { exclude: infer Exclude }
@@ -215,7 +217,7 @@ export type ExtractChainFormatterExclude<
   : ''
 
 export type ExtractChainFormatterParameters<
-  chain extends { formatters?: Chain['formatters'] } | undefined,
+  chain extends Chain | undefined,
   type extends keyof ChainFormatters,
   fallback,
 > = chain extends { formatters?: infer _Formatters extends ChainFormatters }
@@ -225,18 +227,27 @@ export type ExtractChainFormatterParameters<
   : fallback
 
 export type ExtractChainFormatterReturnType<
-  chain extends { formatters?: Chain['formatters'] } | undefined,
+  chain extends Chain | undefined,
   type extends keyof ChainFormatters,
   fallback,
-> = chain extends { formatters?: infer _Formatters extends ChainFormatters }
-  ? _Formatters[type] extends ChainFormatter
-    ? ReturnType<_Formatters[type]['format']>
-    : fallback
+> = chain extends {
+  formatters?:
+    | { [_ in type]?: infer formatter extends ChainFormatter }
+    | undefined
+}
+  ? chain['formatters'] extends undefined
+    ? fallback
+    : ReturnType<formatter['format']>
   : fallback
 
-export type GetChain<
+export type DeriveChain<
+  chain extends Chain | undefined,
+  chainOverride extends Chain | undefined,
+> = chainOverride extends Chain ? chainOverride : chain
+
+export type GetChainParameter<
   chain extends Chain | undefined,
-  chainOverride extends Chain | undefined = undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
 > = IsUndefined<chain> extends true
   ? { chain: chainOverride | null }
   : { chain?: chainOverride | null | undefined }

package/types/contract.ts

@@ -25,7 +25,6 @@ import type {
   MaybeRequired,
   NoUndefined,
   Prettify,
-  UnionEvaluate,
   UnionToTuple,
 } from './utils.js'
 
@@ -139,8 +138,8 @@ export type Widen<type> =
       ? type extends ResolvedRegister['AddressType']
         ? ResolvedRegister['AddressType']
         : type extends ResolvedRegister['BytesType']['inputs']
-        ? ResolvedRegister['BytesType']
-        : string
+          ? ResolvedRegister['BytesType']
+          : string
       : never)
   | (type extends readonly [] ? readonly [] : never)
   | (type extends Record<string, unknown>
@@ -154,6 +153,8 @@ export type Widen<type> =
         : never
       : never)
 
+export type UnionWiden<type> = type extends any ? Widen<type> : never
+
 export type ExtractAbiFunctionForArgs<
   abi extends Abi,
   mutability extends AbiStateMutability,
@@ -165,7 +166,8 @@ export type ExtractAbiFunctionForArgs<
   mutability
 > extends infer abiFunction extends AbiFunction
   ? IsUnion<abiFunction> extends true // narrow overloads using `args` by converting to tuple and filtering out overloads that don't match
-    ? UnionToTuple<abiFunction> extends infer abiFunctions extends readonly AbiFunction[]
+    ? UnionToTuple<abiFunction> extends infer abiFunctions extends
+        readonly AbiFunction[]
       ? {
           [k in keyof abiFunctions]: (
             readonly [] extends args
@@ -205,25 +207,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 ? UnionWiden<args> : never) | allArgs | undefined
+} & (readonly [] extends allArgs ? {} : { args: Widen<args> })
 
 export type ContractFunctionReturnType<
   abi extends Abi | readonly unknown[] = Abi,
@@ -241,19 +226,19 @@ export type ContractFunctionReturnType<
   ? Abi extends abi
     ? unknown
     : AbiParametersToPrimitiveTypes<
-        ExtractAbiFunctionForArgs<
-          abi,
-          mutability,
-          functionName,
-          args
-        >['outputs']
-      > extends infer types
-    ? types extends readonly []
-      ? void
-      : types extends readonly [infer type]
-      ? type
-      : types
-    : never
+          ExtractAbiFunctionForArgs<
+            abi,
+            mutability,
+            functionName,
+            args
+          >['outputs']
+        > extends infer types
+      ? types extends readonly []
+        ? void
+        : types extends readonly [infer type]
+          ? type
+          : types
+      : never
   : unknown
 
 export type AbiItem = Abi[number]
@@ -324,8 +309,8 @@ export type GetValue<
   ? TAbiFunction['stateMutability'] extends 'payable'
     ? { value?: NoUndefined<TValueType> }
     : TAbiFunction['payable'] extends true
-    ? { value?: NoUndefined<TValueType> }
-    : { value?: never }
+      ? { value?: NoUndefined<TValueType> }
+      : { value?: never }
   : { value?: TValueType }
 
 //////////////////////////////////////////////////////////////////////////////////////////////////
@@ -381,49 +366,48 @@ export type AbiEventParametersToPrimitiveTypes<
 > = TAbiParameters extends readonly []
   ? readonly []
   : Filter<
-      TAbiParameters,
-      Options['IndexedOnly'] extends true ? { indexed: true } : object
-    > extends infer Filtered extends readonly AbiParameter[]
-  ? _HasUnnamedAbiParameter<Filtered> extends true
-    ? // Has unnamed tuple parameters so return as array
-        | readonly [
-            ...{
-              [K in keyof Filtered]: AbiEventParameterToPrimitiveType<
-                Filtered[K],
-                Options
-              >
-            },
-          ]
-        // Distribute over tuple to represent optional parameters
-        | (Options['Required'] extends true
-            ? never
-            : // Distribute over tuple to represent optional parameters
-            Filtered extends readonly [
-                ...infer Head extends readonly AbiParameter[],
-                infer _,
-              ]
-            ? AbiEventParametersToPrimitiveTypes<
-                readonly [...{ [K in keyof Head]: Omit<Head[K], 'name'> }],
-                Options
-              >
-            : never)
-    : // All tuple parameters are named so return as object
-    {
-        [Parameter in
-          Filtered[number] as Parameter extends {
-            name: infer Name extends string
-          }
-            ? Name
-            : never]?: AbiEventParameterToPrimitiveType<Parameter, Options>
-      } extends infer Mapped
-    ? Prettify<
-        MaybeRequired<
-          Mapped,
-          Options['Required'] extends boolean ? Options['Required'] : false
-        >
-      >
+        TAbiParameters,
+        Options['IndexedOnly'] extends true ? { indexed: true } : object
+      > extends infer Filtered extends readonly AbiParameter[]
+    ? _HasUnnamedAbiParameter<Filtered> extends true
+      ? // Has unnamed tuple parameters so return as array
+          | readonly [
+              ...{
+                [K in keyof Filtered]: AbiEventParameterToPrimitiveType<
+                  Filtered[K],
+                  Options
+                >
+              },
+            ]
+          // Distribute over tuple to represent optional parameters
+          | (Options['Required'] extends true
+              ? never
+              : // Distribute over tuple to represent optional parameters
+                Filtered extends readonly [
+                    ...infer Head extends readonly AbiParameter[],
+                    infer _,
+                  ]
+                ? AbiEventParametersToPrimitiveTypes<
+                    readonly [...{ [K in keyof Head]: Omit<Head[K], 'name'> }],
+                    Options
+                  >
+                : never)
+      : // All tuple parameters are named so return as object
+        {
+            [Parameter in Filtered[number] as Parameter extends {
+              name: infer Name extends string
+            }
+              ? Name
+              : never]?: AbiEventParameterToPrimitiveType<Parameter, Options>
+          } extends infer Mapped
+        ? Prettify<
+            MaybeRequired<
+              Mapped,
+              Options['Required'] extends boolean ? Options['Required'] : false
+            >
+          >
+        : never
     : never
-  : never
 
 // TODO: Speed up by returning immediately as soon as named parameter is found.
 type _HasUnnamedAbiParameter<TAbiParameters extends readonly AbiParameter[]> =
@@ -447,10 +431,10 @@ export type LogTopicType<
 > = TTopic extends Hex
   ? TPrimitiveType
   : TTopic extends Hex[]
-  ? TPrimitiveType[]
-  : TTopic extends null
-  ? null
-  : never
+    ? TPrimitiveType[]
+    : TTopic extends null
+      ? null
+      : never
 
 /**
  * @internal

package/types/eip1193.ts

@@ -709,6 +709,14 @@ export type TestRpcSchema<TMode extends string> = [
     Parameters: [hash: Hash]
     ReturnType: void
   },
+  /**
+   * @description Serializes the current state (including contracts code, contract's storage, accounts properties, etc.) into a savable data blob.
+   */
+  {
+    Method: `${TMode}_dumpState`
+    Parameters?: undefined
+    ReturnType: Hex
+  },
   /**
    * @description Turn on call traces for transactions that are returned to the user when they execute a transaction (instead of just txhash/receipt).
    */
@@ -735,6 +743,14 @@ export type TestRpcSchema<TMode extends string> = [
     Parameters?: undefined
     ReturnType: boolean
   },
+  /**
+   * @description Adds state previously dumped with `dumpState` to the current chain.
+   */
+  {
+    Method: `${TMode}_loadState`
+    Parameters?: [Hex]
+    ReturnType: void
+  },
   /**
    * @description Advance the block number of the network by a certain number of blocks
    * @link https://hardhat.org/hardhat-network/docs/reference#hardhat_mine
@@ -1314,6 +1330,13 @@ export type EIP1193Parameters<
       params?: unknown
     }
 
+export type EIP1193RequestOptions = {
+  // The base delay (in ms) between retries.
+  retryDelay?: number
+  // The max number of times to retry.
+  retryCount?: number
+}
+
 type DerivedRpcSchema<
   TRpcSchema extends RpcSchema | undefined,
   TRpcSchemaOverride extends RpcSchemaOverride | undefined,
@@ -1339,4 +1362,5 @@ export type EIP1193RequestFn<
     : unknown,
 >(
   args: TParameters,
+  options?: EIP1193RequestOptions,
 ) => Promise<_ReturnType>

package/types/ens.ts

@@ -1,5 +1,5 @@
 export type AssetGateway = 'ipfs' | 'arweave'
 
 export type AssetGatewayUrls = {
-  [key in AssetGateway]?: string
+  [_key in AssetGateway]?: string
 }