feat: extractChain (wevm#1402)

* feat: extractChain

* chore: changeset

* fix

.changeset/large-pens-search.md

@@ -0,0 +1,5 @@
+---
+"viem": minor
+---
+
+Added `extractChain` utility.

.github/CONTRIBUTING.md

@@ -262,7 +262,7 @@ Example:
 
 ```ts
 // src/chains/definitions/example.ts
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const mainnet = /*#__PURE__*/ defineChain({
   id: 1,

site/.vitepress/sidebar.ts

@@ -645,6 +645,15 @@ export const sidebar: DefaultTheme.Sidebar = {
             },
           ],
         },
+        {
+          text: 'Chain',
+          items: [
+            {
+              text: 'extractChain',
+              link: '/docs/utilities/extractChain',
+            },
+          ],
+        },
         {
           text: 'Data',
           items: [

site/docs/clients/chains.md

@@ -361,3 +361,7 @@ const example = defineChain(
   }
 )
 ```
+
+## Utilities
+
+- [`extractChain`](/docs/utilities/extractChain): Extracts a type-safe chain by ID.

site/docs/utilities/extractChain.md

@@ -0,0 +1,63 @@
+# extractChain
+
+Extracts a type-safe chain by ID from a set of chains.
+
+## Usage
+
+```ts
+import { extractChain } from 'viem'
+import { mainnet, base, optimism, zora } from 'viem/chains'
+
+const optimism = extractChain({
+  chains: [mainnet, base, optimism, zora],
+  id: 10,
+})
+
+optimism.id
+//       ^? (property) id: 10
+optimism.name
+//       ^? (property) name: "OP Mainnet"
+```
+
+It is also possible to use **all chains** from the `viem/chains` module:
+
+```ts
+import { extractChain } from 'viem'
+import { mainnet, base, optimism, zora } from 'viem/chains' // [!code --]
+import * as chains from 'viem/chains' // [!code ++]
+
+const optimism = extractChain({
+  chains: [mainnet, base, optimism, zora], // [!code --]
+  chains: Object.values(chains), // [!code ++]
+  id: 10,
+})
+
+optimism.id
+//       ^? (property) id: 10
+optimism.name
+//       ^? (property) name: "OP Mainnet"
+```
+
+::: warning
+By importing all chains from `viem/chains`, this will significantly increase the size of your bundle. It is only recommended to use this method where bundle size is not a concern (ie. server-side, scripts, etc).
+:::
+
+## Returns
+
+- **Type:** `Chain` (inferred)
+
+The extracted chain.
+
+## Parameters
+
+### chains
+
+- **Type:** `readonly Chain[]`
+
+The set of chains where the chain will be extracted from.
+
+### id
+
+- **Type:** `number`
+
+The ID of the chain to extract.

src/actions/ens/getEnsAddress.ts

@@ -20,7 +20,7 @@ import {
 import {
   type GetChainContractAddressErrorType,
   getChainContractAddress,
-} from '../../utils/chain.js'
+} from '../../utils/chain/getChainContractAddress.js'
 import { type TrimErrorType, trim } from '../../utils/data/trim.js'
 import { type ToHexErrorType, toHex } from '../../utils/encoding/toHex.js'
 import { isNullUniversalResolverError } from '../../utils/ens/errors.js'

src/actions/ens/getEnsName.ts

@@ -9,7 +9,7 @@ import type { Prettify } from '../../types/utils.js'
 import {
   type GetChainContractAddressErrorType,
   getChainContractAddress,
-} from '../../utils/chain.js'
+} from '../../utils/chain/getChainContractAddress.js'
 import { type ToHexErrorType, toHex } from '../../utils/encoding/toHex.js'
 import { isNullUniversalResolverError } from '../../utils/ens/errors.js'
 import {

src/actions/ens/getEnsResolver.ts

@@ -8,7 +8,7 @@ import type { Prettify } from '../../types/utils.js'
 import {
   type GetChainContractAddressErrorType,
   getChainContractAddress,
-} from '../../utils/chain.js'
+} from '../../utils/chain/getChainContractAddress.js'
 import { type ToHexErrorType, toHex } from '../../utils/encoding/toHex.js'
 import {
   type PacketToBytesErrorType,

src/actions/ens/getEnsText.ts

@@ -19,7 +19,7 @@ import {
 import {
   type GetChainContractAddressErrorType,
   getChainContractAddress,
-} from '../../utils/chain.js'
+} from '../../utils/chain/getChainContractAddress.js'
 import { type ToHexErrorType, toHex } from '../../utils/encoding/toHex.js'
 import { isNullUniversalResolverError } from '../../utils/ens/errors.js'
 import { type NamehashErrorType, namehash } from '../../utils/ens/namehash.js'

src/actions/public/call.ts

@@ -37,7 +37,7 @@ import type { RequestErrorType } from '../../utils/buildRequest.js'
 import {
   type GetChainContractAddressErrorType,
   getChainContractAddress,
-} from '../../utils/chain.js'
+} from '../../utils/chain/getChainContractAddress.js'
 import {
   type NumberToHexErrorType,
   numberToHex,

src/actions/public/multicall.ts

@@ -25,7 +25,7 @@ import {
 import {
   type GetChainContractAddressErrorType,
   getChainContractAddress,
-} from '../../utils/chain.js'
+} from '../../utils/chain/getChainContractAddress.js'
 import {
   type GetContractErrorReturnType,
   getContractError,

src/actions/test/sendUnsignedTransaction.test.ts

@@ -4,7 +4,7 @@ import { accounts, address } from '~test/src/constants.js'
 import { publicClient, testClient } from '~test/src/utils.js'
 import { celo } from '../../chains/index.js'
 import { createTestClient } from '../../clients/createTestClient.js'
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 import { parseEther } from '../../utils/unit/parseEther.js'
 import { getBalance } from '../public/getBalance.js'
 

src/actions/wallet/sendTransaction.test.ts

@@ -14,7 +14,7 @@ import { createWalletClient } from '../../clients/createWalletClient.js'
 import { http } from '../../clients/transports/http.js'
 import { type Hex } from '../../types/misc.js'
 import { type TransactionSerializable } from '../../types/transaction.js'
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 import { concatHex } from '../../utils/data/concat.js'
 import { hexToNumber } from '../../utils/encoding/fromHex.js'
 import { toHex } from '../../utils/encoding/toHex.js'

src/actions/wallet/sendTransaction.ts

@@ -22,7 +22,7 @@ import type { RequestErrorType } from '../../utils/buildRequest.js'
 import {
   type AssertCurrentChainErrorType,
   assertCurrentChain,
-} from '../../utils/chain.js'
+} from '../../utils/chain/assertCurrentChain.js'
 import {
   type GetTransactionErrorReturnType,
   getTransactionError,

src/actions/wallet/signTransaction.ts

@@ -21,7 +21,7 @@ import type { RequestErrorType } from '../../utils/buildRequest.js'
 import {
   type AssertCurrentChainErrorType,
   assertCurrentChain,
-} from '../../utils/chain.js'
+} from '../../utils/chain/assertCurrentChain.js'
 import type { NumberToHexErrorType } from '../../utils/encoding/toHex.js'
 import {
   type FormattedTransactionRequest,

src/chains/definitions/arbitrum.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const arbitrum = /*#__PURE__*/ defineChain({
   id: 42_161,

src/chains/definitions/arbitrumGoerli.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const arbitrumGoerli = /*#__PURE__*/ defineChain({
   id: 421_613,

src/chains/definitions/arbitrumNova.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const arbitrumNova = /*#__PURE__*/ defineChain({
   id: 42_170,

src/chains/definitions/arbitrumSepolia.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const arbitrumSepolia = /*#__PURE__*/ defineChain({
   id: 421_614,

src/chains/definitions/astarZkatana.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const astarZkatana = /*#__PURE__*/ defineChain({
   id: 1_261_120,

src/chains/definitions/aurora.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const aurora = /*#__PURE__*/ defineChain({
   id: 1313161554,

src/chains/definitions/auroraTestnet.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const auroraTestnet = /*#__PURE__*/ defineChain({
   id: 1313161555,

src/chains/definitions/avalanche.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const avalanche = /*#__PURE__*/ defineChain({
   id: 43_114,

src/chains/definitions/avalancheFuji.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const avalancheFuji = /*#__PURE__*/ defineChain({
   id: 43_113,

src/chains/definitions/base.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 import { formattersOptimism } from '../optimism/formatters.js'
 
 export const base = /*#__PURE__*/ defineChain(

src/chains/definitions/baseGoerli.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 import { formattersOptimism } from '../optimism/formatters.js'
 
 export const baseGoerli = /*#__PURE__*/ defineChain(

src/chains/definitions/baseSepolia.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 import { formattersOptimism } from '../optimism/formatters.js'
 
 export const baseSepolia = /*#__PURE__*/ defineChain(

src/chains/definitions/bearNetworkChainMainnet.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const bearNetworkChainMainnet = /*#__PURE__*/ defineChain({
   id: 641230,

src/chains/definitions/bearNetworkChainTestnet.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const bearNetworkChainTestnet = /*#__PURE__*/ defineChain({
   id: 751230,

src/chains/definitions/boba.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const boba = /*#__PURE__*/ defineChain({
   id: 288,

src/chains/definitions/bronos.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const bronos = /*#__PURE__*/ defineChain({
   id: 1039,

src/chains/definitions/bronosTestnet.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const bronosTestnet = /*#__PURE__*/ defineChain({
   id: 1038,

src/chains/definitions/bsc.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const bsc = /*#__PURE__*/ defineChain({
   id: 56,

src/chains/definitions/bscTestnet.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const bscTestnet = /*#__PURE__*/ defineChain({
   id: 97,

src/chains/definitions/bxn.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const bxn = /*#__PURE__*/ defineChain({
   id: 4999,

src/chains/definitions/bxnTestnet.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const bxnTestnet = /*#__PURE__*/ defineChain({
   id: 4777,

src/chains/definitions/canto.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const canto = /*#__PURE__*/ defineChain({
   id: 7_700,

src/chains/definitions/celo.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 import { formattersCelo } from '../celo/formatters.js'
 import { serializersCelo } from '../celo/serializers.js'
 

src/chains/definitions/celoAlfajores.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 import { formattersCelo } from '../celo/formatters.js'
 import { serializersCelo } from '../celo/serializers.js'
 

src/chains/definitions/celoCannoli.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 import { formattersCelo } from '../celo/formatters.js'
 import { serializersCelo } from '../celo/serializers.js'
 

src/chains/definitions/classic.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const classic = /*#__PURE__*/ defineChain({
   id: 61,

src/chains/definitions/confluxESpace.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const confluxESpace = /*#__PURE__*/ defineChain({
   id: 1_030,

src/chains/definitions/coreDao.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const coreDao = /*#__PURE__*/ defineChain({
   id: 1116,

src/chains/definitions/cronos.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const cronos = /*#__PURE__*/ defineChain({
   id: 25,

src/chains/definitions/cronosTestnet.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const cronosTestnet = /*#__PURE__*/ defineChain({
   id: 338,

src/chains/definitions/crossbell.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const crossbell = /*#__PURE__*/ defineChain({
   id: 3_737,

src/chains/definitions/dfk.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const dfk = /*#__PURE__*/ defineChain({
   id: 53_935,

src/chains/definitions/dogechain.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const dogechain = /*#__PURE__*/ defineChain({
   id: 2_000,

src/chains/definitions/edgeware.ts

@@ -1,4 +1,4 @@
-import { defineChain } from '../../utils/chain.js'
+import { defineChain } from '../../utils/chain/defineChain.js'
 
 export const edgeware = /*#__PURE__*/ defineChain({
   id: 2021,