viem 1.10.8 → 2.0.0-alpha.0

package/package.json

@@ -1,168 +1,131 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "dependencies": {
-    "@adraffy/ens-normalize": "1.9.4",
-    "@noble/curves": "1.2.0",
-    "@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",
-    "ws": "8.13.0"
-  },
-  "peerDependencies": {
-    "typescript": ">=5.0.4"
-  },
-  "peerDependenciesMeta": {
-    "typescript": {
-      "optional": true
-    }
-  },
-  "version": "1.10.8",
+  "version": "2.0.0-alpha.0",
+  "type": "module",
+  "main": "./_cjs/index.js",
+  "module": "./_esm/index.js",
+  "types": "./_types/index.d.ts",
+  "typings": "./_types/index.d.ts",
+  "sideEffects": false,
   "files": [
-    "dist",
-    "!dist/**/*.tsbuildinfo",
-    "src/**/*.ts",
-    "!src/**/*.test.ts",
-    "!src/**/*.test-d.ts",
-    "!src/**/*.bench.ts",
-    "!src/_test/**/*",
-    "abi",
-    "accounts",
-    "actions",
-    "chains",
-    "chains/utils",
-    "contract",
-    "ens",
-    "public",
-    "test",
-    "utils",
-    "wallet",
-    "window"
+    "*",
+    "!**/*.tsbuildinfo",
+    "!**/*.test.ts",
+    "!**/*.test-d.ts",
+    "!**/*.bench.ts",
+    "!tsconfig.build.json"
   ],
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "default": "./dist/cjs/index.js"
+      "types": "./_types/index.d.ts",
+      "import": "./_esm/index.js",
+      "default": "./_cjs/index.js"
     },
     "./abi": {
-      "types": "./dist/types/abi.d.ts",
-      "import": "./dist/esm/abi.js",
-      "default": "./dist/cjs/abi.js"
+      "types": "./_types/abi.d.ts",
+      "import": "./_esm/abi.js",
+      "default": "./_cjs/abi.js"
     },
     "./accounts": {
-      "types": "./dist/types/accounts/index.d.ts",
-      "import": "./dist/esm/accounts/index.js",
-      "default": "./dist/cjs/accounts/index.js"
+      "types": "./_types/accounts/index.d.ts",
+      "import": "./_esm/accounts/index.js",
+      "default": "./_cjs/accounts/index.js"
     },
     "./actions": {
-      "types": "./dist/types/actions/index.d.ts",
-      "import": "./dist/esm/actions/index.js",
-      "default": "./dist/cjs/actions/index.js"
+      "types": "./_types/actions/index.d.ts",
+      "import": "./_esm/actions/index.js",
+      "default": "./_cjs/actions/index.js"
     },
     "./chains": {
-      "types": "./dist/types/chains/index.d.ts",
-      "import": "./dist/esm/chains/index.js",
-      "default": "./dist/cjs/chains/index.js"
+      "types": "./_types/chains/index.d.ts",
+      "import": "./_esm/chains/index.js",
+      "default": "./_cjs/chains/index.js"
     },
     "./chains/utils": {
-      "types": "./dist/types/chains/utils.d.ts",
-      "import": "./dist/esm/chains/utils.js",
-      "default": "./dist/cjs/chains/utils.js"
+      "types": "./_types/chains/utils.d.ts",
+      "import": "./_esm/chains/utils.js",
+      "default": "./_cjs/chains/utils.js"
     },
     "./contract": {
-      "types": "./dist/types/contract.d.ts",
-      "import": "./dist/esm/contract.js",
-      "default": "./dist/cjs/contract.js"
+      "types": "./_types/contract.d.ts",
+      "import": "./_esm/contract.js",
+      "default": "./_cjs/contract.js"
     },
     "./ens": {
-      "types": "./dist/types/ens.d.ts",
-      "import": "./dist/esm/ens.js",
-      "default": "./dist/cjs/ens.js"
+      "types": "./_types/ens.d.ts",
+      "import": "./_esm/ens.js",
+      "default": "./_cjs/ens.js"
     },
     "./public": {
-      "types": "./dist/types/public.d.ts",
-      "import": "./dist/esm/public.js",
-      "default": "./dist/cjs/public.js"
+      "types": "./_types/public.d.ts",
+      "import": "./_esm/public.js",
+      "default": "./_cjs/public.js"
     },
     "./test": {
-      "types": "./dist/types/test.d.ts",
-      "import": "./dist/esm/test.js",
-      "default": "./dist/cjs/test.js"
+      "types": "./_types/test.d.ts",
+      "import": "./_esm/test.js",
+      "default": "./_cjs/test.js"
     },
     "./utils": {
-      "types": "./dist/types/utils/index.d.ts",
-      "import": "./dist/esm/utils/index.js",
-      "default": "./dist/cjs/utils/index.js"
+      "types": "./_types/utils/index.d.ts",
+      "import": "./_esm/utils/index.js",
+      "default": "./_cjs/utils/index.js"
     },
     "./wallet": {
-      "types": "./dist/types/wallet.d.ts",
-      "import": "./dist/esm/wallet.js",
-      "default": "./dist/cjs/wallet.js"
+      "types": "./_types/wallet.d.ts",
+      "import": "./_esm/wallet.js",
+      "default": "./_cjs/wallet.js"
     },
     "./window": {
-      "types": "./dist/types/window.d.ts",
-      "import": "./dist/esm/window.js",
-      "default": "./dist/cjs/window.js"
+      "types": "./_types/window.d.ts",
+      "import": "./_esm/window.js",
+      "default": "./_cjs/window.js"
     },
     "./package.json": "./package.json"
   },
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/types/index.d.ts",
-  "typings": "./dist/types/index.d.ts",
   "typesVersions": {
     "*": {
-      "abi": [
-        "./dist/types/abi.d.ts"
-      ],
-      "accounts": [
-        "./dist/types/accounts/index.d.ts"
-      ],
-      "actions": [
-        "./dist/types/actions/index.d.ts"
-      ],
-      "chains": [
-        "./dist/types/chains.d.ts"
-      ],
-      "contract": [
-        "./dist/types/contract.d.ts"
-      ],
-      "ens": [
-        "./dist/types/ens.d.ts"
-      ],
-      "public": [
-        "./dist/types/public.d.ts"
-      ],
-      "test": [
-        "./dist/types/test.d.ts"
-      ],
-      "utils": [
-        "./dist/types/utils/index.d.ts"
-      ],
-      "wallet": [
-        "./dist/types/wallet.d.ts"
-      ],
-      "window": [
-        "./dist/types/window.d.ts"
-      ]
+      "abi": ["./_types/abi.d.ts"],
+      "accounts": ["./_types/accounts/index.d.ts"],
+      "actions": ["./_types/actions/index.d.ts"],
+      "chains": ["./_types/chains.d.ts"],
+      "contract": ["./_types/contract.d.ts"],
+      "ens": ["./_types/ens.d.ts"],
+      "public": ["./_types/public.d.ts"],
+      "test": ["./_types/test.d.ts"],
+      "utils": ["./_types/utils/index.d.ts"],
+      "wallet": ["./_types/wallet.d.ts"],
+      "window": ["./_types/window.d.ts"]
     }
   },
-  "sideEffects": false,
+  "peerDependencies": {
+    "typescript": ">=5.0.4"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@adraffy/ens-normalize": "1.9.4",
+    "@noble/curves": "1.2.0",
+    "@noble/hashes": "1.3.2",
+    "@scure/bip32": "1.3.2",
+    "@scure/bip39": "1.2.1",
+    "@types/ws": "^8.5.5",
+    "abitype": "0.9.8",
+    "unws": "0.2.4",
+    "ws": "8.13.0"
+  },
   "license": "MIT",
   "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/chain.ts

@@ -0,0 +1,252 @@
+import type { Address } from 'abitype'
+
+import type { EstimateFeesPerGasReturnType } from '../actions/public/estimateFeesPerGas.js'
+import type { PrepareTransactionRequestParameters } from '../actions/wallet/prepareTransactionRequest.js'
+import type { Client } from '../clients/createClient.js'
+import type { Transport } from '../clients/transports/createTransport.js'
+import type { Account } from '../types/account.js'
+import type { FeeValuesType } from '../types/fee.js'
+import type {
+  TransactionSerializable,
+  TransactionSerializableGeneric,
+} from '../types/transaction.js'
+import type { IsUndefined, Prettify } from '../types/utils.js'
+import type { FormattedBlock } from '../utils/formatters/block.js'
+import type { SerializeTransactionFn } from '../utils/transaction/serializeTransaction.js'
+
+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?:
+    | {
+        default: ChainBlockExplorer
+        etherscan?: ChainBlockExplorer | undefined
+      }
+    | undefined
+  /** Collection of contracts */
+  contracts?:
+    | Prettify<
+        {
+          [key: string]:
+            | ChainContract
+            | { [chainId: number]: ChainContract | undefined }
+            | undefined
+        } & {
+          ensRegistry?: ChainContract | undefined
+          ensUniversalResolver?: ChainContract | undefined
+          multicall3?: ChainContract | undefined
+        }
+      >
+    | undefined
+  /** ID in number form */
+  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,
+}
+
+export type ChainContract = {
+  address: Address
+  blockCreated?: number | undefined
+}
+
+type ChainNativeCurrency = {
+  name: string
+  /** 2-6 characters long */
+  symbol: string
+  decimals: number
+}
+
+type ChainRpcUrls = {
+  http: readonly string[]
+  webSocket?: readonly string[] | undefined
+}
+
+/////////////////////////////////////////////////////////////////////
+// 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,
+> = {
+  /**
+   * The fee multiplier to use to account for fee fluctuations.
+   * Used in the [`estimateFeesPerGas` Action](/docs/actions/public/estimateFeesPerGas).
+   *
+   * @default 1.2
+   */
+  baseFeeMultiplier?:
+    | number
+    | ((args: ChainFeesFnParameters<formatters>) => Promise<number> | number)
+  /**
+   * The default `maxPriorityFeePerGas` to use when a priority
+   * fee is not defined upon sending a transaction.
+   *
+   * Overrides the return value in the [`estimateMaxPriorityFeePerGas` Action](/docs/actions/public/estimateMaxPriorityFeePerGas).
+   */
+  defaultPriorityFee?:
+    | bigint
+    | ((args: ChainFeesFnParameters<formatters>) => Promise<bigint> | bigint)
+    | undefined
+  /**
+   * Allows customization of fee per gas values (e.g. `maxFeePerGas`/`maxPriorityFeePerGas`).
+   *
+   * Overrides the return value in the [`estimateFeesPerGas` Action](/docs/actions/public/estimateFeesPerGas).
+   */
+  estimateFeesPerGas?:
+    | ((
+        args: ChainEstimateFeesPerGasFnParameters<formatters>,
+      ) => Promise<EstimateFeesPerGasReturnType>)
+    | bigint
+    | undefined
+}
+
+export type ChainFormatters = {
+  /** Modifies how the Block structure is formatted & typed. */
+  block?: ChainFormatter<'block'> | undefined
+  /** Modifies how the Transaction structure is formatted & typed. */
+  transaction?: ChainFormatter<'transaction'> | undefined
+  /** Modifies how the TransactionReceipt structure is formatted & typed. */
+  transactionReceipt?: ChainFormatter<'transactionReceipt'> | undefined
+  /** Modifies how the TransactionRequest structure is formatted & typed. */
+  transactionRequest?: ChainFormatter<'transactionRequest'> | undefined
+}
+
+export type ChainFormatter<type extends string = string> = {
+  format: (args: any) => any
+  type: type
+}
+
+export type ChainSerializers<
+  formatters extends ChainFormatters | undefined = undefined,
+> = {
+  /** Modifies how Transactions are serialized. */
+  transaction?:
+    | SerializeTransactionFn<
+        formatters extends ChainFormatters
+          ? formatters['transactionRequest'] extends ChainFormatter
+            ? TransactionSerializableGeneric &
+                Parameters<formatters['transactionRequest']['format']>[0]
+            : TransactionSerializable
+          : TransactionSerializable
+      >
+    | undefined
+}
+
+/////////////////////////////////////////////////////////////////////
+// Parameters
+
+export type ChainFeesFnParameters<
+  formatters extends ChainFormatters | undefined = ChainFormatters | undefined,
+> = {
+  /** The latest block. */
+  block: Prettify<FormattedBlock<{ formatters: formatters }>>
+  client: Client<Transport, Chain>
+  /**
+   * A transaction request. This value will be undefined if the caller
+   * is outside of a transaction request context (e.g. a direct call to
+   * the `estimateFeesPerGas` Action).
+   */
+  request?:
+    | PrepareTransactionRequestParameters<
+        Omit<Chain, 'formatters'> & { formatters: formatters },
+        Account | undefined,
+        undefined
+      >
+    | undefined
+}
+
+export type ChainEstimateFeesPerGasFnParameters<
+  formatters extends ChainFormatters | undefined = ChainFormatters | undefined,
+> = {
+  /**
+   * A function to multiply the base fee based on the `baseFeeMultiplier` value.
+   */
+  multiply(x: bigint): bigint
+  /**
+   * The type of fees to return.
+   */
+  type: FeeValuesType
+} & ChainFeesFnParameters<formatters>
+
+/////////////////////////////////////////////////////////////////////
+// Utils
+
+export type ExtractChainFormatterExclude<
+  chain extends { formatters?: Chain['formatters'] } | undefined,
+  type extends keyof ChainFormatters,
+> = chain extends { formatters?: infer _Formatters extends ChainFormatters }
+  ? _Formatters[type] extends { exclude: infer Exclude }
+    ? Extract<Exclude, string[]>[number]
+    : ''
+  : ''
+
+export type ExtractChainFormatterParameters<
+  chain extends { formatters?: Chain['formatters'] } | undefined,
+  type extends keyof ChainFormatters,
+  fallback,
+> = chain extends { formatters?: infer _Formatters extends ChainFormatters }
+  ? _Formatters[type] extends ChainFormatter
+    ? Parameters<_Formatters[type]['format']>[0]
+    : fallback
+  : fallback
+
+export type ExtractChainFormatterReturnType<
+  chain extends { formatters?: Chain['formatters'] } | undefined,
+  type extends keyof ChainFormatters,
+  fallback,
+> = chain extends { formatters?: infer _Formatters extends ChainFormatters }
+  ? _Formatters[type] extends ChainFormatter
+    ? ReturnType<_Formatters[type]['format']>
+    : fallback
+  : fallback
+
+export type GetChain<
+  chain extends Chain | undefined,
+  chainOverride extends Chain | undefined = undefined,
+> = IsUndefined<chain> extends true
+  ? { chain: chainOverride | null }
+  : { chain?: chainOverride | null }