viem 1.17.1 → 1.18.0

package/clients/decorators/public.ts

@@ -859,7 +859,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>,
@@ -1115,7 +1115,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>
   /**
@@ -1324,7 +1326,9 @@ export type PublicActions<
    *   value: 1n,
    * })
    */
-  prepareTransactionRequest: <TChainOverride extends Chain | undefined,>(
+  prepareTransactionRequest: <
+    TChainOverride extends Chain | undefined = undefined,
+  >(
     args: PrepareTransactionRequestParameters<TChain, TAccount, TChainOverride>,
   ) => Promise<PrepareTransactionRequestReturnType>
   /**
@@ -1424,7 +1428,7 @@ export type PublicActions<
   simulateContract: <
     const TAbi extends Abi | readonly unknown[],
     TFunctionName extends string,
-    TChainOverride extends Chain | undefined,
+    TChainOverride extends Chain | undefined = undefined,
   >(
     args: SimulateContractParameters<
       TAbi,

package/clients/decorators/wallet.ts

@@ -128,7 +128,7 @@ export type WalletActions<
    */
   deployContract: <
     const TAbi extends Abi | readonly unknown[],
-    TChainOverride extends Chain | undefined,
+    TChainOverride extends Chain | undefined = undefined,
   >(
     args: DeployContractParameters<TAbi, TChain, TAccount, TChainOverride>,
   ) => Promise<DeployContractReturnType>
@@ -228,7 +228,9 @@ export type WalletActions<
    *   value: 1n,
    * })
    */
-  prepareTransactionRequest: <TChainOverride extends Chain | undefined,>(
+  prepareTransactionRequest: <
+    TChainOverride extends Chain | undefined = undefined,
+  >(
     args: PrepareTransactionRequestParameters<TChain, TAccount, TChainOverride>,
   ) => Promise<PrepareTransactionRequestReturnType>
   /**
@@ -347,7 +349,7 @@ export type WalletActions<
    *   value: 1000000000000000000n,
    * })
    */
-  sendTransaction: <TChainOverride extends Chain | undefined>(
+  sendTransaction: <TChainOverride extends Chain | undefined = undefined>(
     args: SendTransactionParameters<TChain, TAccount, TChainOverride>,
   ) => Promise<SendTransactionReturnType>
   /**
@@ -439,7 +441,7 @@ export type WalletActions<
    * })
    * const signature = await client.signTransaction(request)
    */
-  signTransaction: <TChainOverride extends Chain | undefined,>(
+  signTransaction: <TChainOverride extends Chain | undefined = undefined>(
     args: SignTransactionParameters<TChain, TAccount, TChainOverride>,
   ) => Promise<SignTransactionReturnType>
   /**
@@ -640,7 +642,7 @@ export type WalletActions<
   writeContract: <
     const TAbi extends Abi | readonly unknown[],
     TFunctionName extends string,
-    TChainOverride extends Chain | undefined,
+    TChainOverride extends Chain | undefined = undefined,
   >(
     args: WriteContractParameters<
       TAbi,

package/index.ts

@@ -1233,11 +1233,19 @@ export {
 export {
   type AssertCurrentChainErrorType,
   type AssertCurrentChainParameters,
-  type GetChainContractAddressErrorType,
   assertCurrentChain,
-  defineChain,
+} from './utils/chain/assertCurrentChain.js'
+export { defineChain } from './utils/chain/defineChain.js'
+export {
+  type ExtractChainErrorType,
+  type ExtractChainParameters,
+  type ExtractChainReturnType,
+  extractChain,
+} from './utils/chain/extractChain.js'
+export {
+  type GetChainContractAddressErrorType,
   getChainContractAddress,
-} from './utils/chain.js'
+} from './utils/chain/getChainContractAddress.js'
 export {
   type EncodePackedErrorType,
   encodePacked,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "viem",
   "description": "TypeScript Interface for Ethereum",
-  "version": "1.17.1",
+  "version": "1.18.0",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",

package/types/chain.ts

@@ -198,6 +198,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,

package/utils/chain/assertCurrentChain.ts

@@ -0,0 +1,27 @@
+import {
+  ChainMismatchError,
+  type ChainMismatchErrorType,
+  ChainNotFoundError,
+  type ChainNotFoundErrorType,
+} from '../../errors/chain.js'
+import type { ErrorType } from '../../errors/utils.js'
+import type { Chain } from '../../types/chain.js'
+
+export type AssertCurrentChainParameters = {
+  chain?: Chain
+  currentChainId: number
+}
+
+export type AssertCurrentChainErrorType =
+  | ChainNotFoundErrorType
+  | ChainMismatchErrorType
+  | ErrorType
+
+export function assertCurrentChain({
+  chain,
+  currentChainId,
+}: AssertCurrentChainParameters): void {
+  if (!chain) throw new ChainNotFoundError()
+  if (currentChainId !== chain.id)
+    throw new ChainMismatchError({ chain, currentChainId })
+}

package/utils/chain/defineChain.ts

@@ -0,0 +1,22 @@
+import type { Chain, ChainConfig, ChainFormatters } from '../../types/chain.js'
+import type { Assign } from '../../types/utils.js'
+
+export function defineChain<
+  const chain extends Chain,
+  formatters extends ChainFormatters | undefined = undefined,
+>(
+  chain: chain,
+  config: ChainConfig<formatters> = {},
+): Assign<chain, ChainConfig<formatters>> {
+  const {
+    fees = chain.fees,
+    formatters = chain.formatters,
+    serializers = chain.serializers,
+  } = config
+  return {
+    ...chain,
+    fees,
+    formatters,
+    serializers,
+  } as unknown as Assign<chain, ChainConfig<formatters>>
+}

package/utils/chain/extractChain.ts

@@ -0,0 +1,33 @@
+import type { ErrorType } from '../../errors/utils.js'
+import type { Chain, ExtractChain } from '../../types/chain.js'
+
+export type ExtractChainParameters<
+  chains extends readonly Chain[],
+  chainId extends chains[number]['id'],
+> = {
+  chains: chains
+  id: chainId | chains[number]['id']
+}
+
+export type ExtractChainReturnType<
+  chains extends readonly Chain[],
+  chainId extends chains[number]['id'],
+> = ExtractChain<chains, chainId>
+
+export type ExtractChainErrorType = ErrorType
+
+export function extractChain<
+  const chains extends readonly Chain[],
+  chainId extends chains[number]['id'],
+>({
+  chains,
+  id,
+}: ExtractChainParameters<chains, chainId>): ExtractChainReturnType<
+  chains,
+  chainId
+> {
+  return chains.find((chain) => chain.id === id) as ExtractChainReturnType<
+    chains,
+    chainId
+  >
+}

package/utils/chain/getChainContractAddress.ts

@@ -0,0 +1,41 @@
+import {
+  ChainDoesNotSupportContract,
+  type ChainDoesNotSupportContractErrorType,
+} from '../../errors/chain.js'
+import type { Chain, ChainContract } from '../../types/chain.js'
+
+export type GetChainContractAddressErrorType =
+  ChainDoesNotSupportContractErrorType
+
+export function getChainContractAddress({
+  blockNumber,
+  chain,
+  contract: name,
+}: {
+  blockNumber?: bigint
+  chain: Chain
+  contract: string
+}) {
+  const contract = (chain?.contracts as Record<string, ChainContract>)?.[name]
+  if (!contract)
+    throw new ChainDoesNotSupportContract({
+      chain,
+      contract: { name },
+    })
+
+  if (
+    blockNumber &&
+    contract.blockCreated &&
+    contract.blockCreated > blockNumber
+  )
+    throw new ChainDoesNotSupportContract({
+      blockNumber,
+      chain,
+      contract: {
+        name,
+        blockCreated: contract.blockCreated,
+      },
+    })
+
+  return contract.address
+}

package/utils/formatters/extract.ts

@@ -4,19 +4,30 @@ import type { ChainFormatter } from '../../types/chain.js'
 export type ExtractErrorType = ErrorType
 
 /**
- * @description Picks out the keys from `value` that exist in the formatter.
+ * @description Picks out the keys from `value` that exist in the formatter..
  */
 export function extract(
-  value: Record<string, unknown>,
+  value_: Record<string, unknown>,
   { format }: { format?: ChainFormatter['format'] },
 ) {
   if (!format) return {}
-  const keys = Object.keys(format({}))
-  return keys.reduce((data: Record<string, unknown>, key) => {
-    // biome-ignore lint/suspicious/noPrototypeBuiltins:
-    if (value?.hasOwnProperty(key)) {
-      data[key] = value[key]
+
+  const value: Record<string, unknown> = {}
+  function extract_(formatted: Record<string, any>) {
+    const keys = Object.keys(formatted)
+    for (const key of keys) {
+      if (key in value_) value[key] = value_[key]
+      if (
+        formatted[key] &&
+        typeof formatted[key] === 'object' &&
+        !Array.isArray(formatted[key])
+      )
+        extract_(formatted[key])
     }
-    return data
-  }, {})
+  }
+
+  const formatted = format(value_ || {})
+  extract_(formatted)
+
+  return value
 }

package/utils/formatters/formatter.ts

@@ -10,7 +10,7 @@ export function defineFormatter<TType extends string, TParameters, TReturnType>(
   return <
     TOverrideParameters,
     TOverrideReturnType,
-    TExclude extends (keyof TParameters)[] = [],
+    TExclude extends (keyof TParameters | keyof TOverrideParameters)[] = [],
   >({
     exclude,
     format: overrides,

package/utils/index.ts

@@ -15,13 +15,22 @@ export {
 } from './ccip.js'
 
 export {
-  type AssertCurrentChainParameters,
   type AssertCurrentChainErrorType,
-  type GetChainContractAddressErrorType,
+  type AssertCurrentChainParameters,
   assertCurrentChain,
-  defineChain,
+} from './chain/assertCurrentChain.js'
+export { defineChain } from './chain/defineChain.js'
+export {
+  type ExtractChainErrorType,
+  type ExtractChainParameters,
+  type ExtractChainReturnType,
+  extractChain,
+} from './chain/extractChain.js'
+export {
+  type GetChainContractAddressErrorType,
   getChainContractAddress,
-} from './chain.js'
+} from './chain/getChainContractAddress.js'
+
 export { arrayRegex, bytesRegex, integerRegex } from './regex.js'
 
 export {

package/_cjs/utils/chain.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"chain.js","sourceRoot":"","sources":["../../utils/chain.ts"],"names":[],"mappings":";;;AAAA,iDAO2B;AAoB3B,SAAgB,kBAAkB,CAAC,EACjC,KAAK,EACL,cAAc,GACe;IAC7B,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,6BAAkB,EAAE,CAAA;IAC1C,IAAI,cAAc,KAAK,KAAK,CAAC,EAAE;QAC7B,MAAM,IAAI,6BAAkB,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAA;AAC3D,CAAC;AAPD,gDAOC;AAED,SAAgB,WAAW,CAIzB,KAAY,EACZ,SAAkC,EAAE;IAEpC,MAAM,EACJ,IAAI,GAAG,KAAK,CAAC,IAAI,EACjB,UAAU,GAAG,KAAK,CAAC,UAAU,EAC7B,WAAW,GAAG,KAAK,CAAC,WAAW,GAChC,GAAG,MAAM,CAAA;IACV,OAAO;QACL,GAAG,KAAK;QACR,IAAI;QACJ,UAAU;QACV,WAAW;KACyC,CAAA;AACxD,CAAC;AAlBD,kCAkBC;AAKD,SAAgB,uBAAuB,CAAC,EACtC,WAAW,EACX,KAAK,EACL,QAAQ,EAAE,IAAI,GAKf;IACC,MAAM,QAAQ,GAAI,KAAK,EAAE,SAA2C,EAAE,CAAC,IAAI,CAAC,CAAA;IAC5E,IAAI,CAAC,QAAQ;QACX,MAAM,IAAI,sCAA2B,CAAC;YACpC,KAAK;YACL,QAAQ,EAAE,EAAE,IAAI,EAAE;SACnB,CAAC,CAAA;IAEJ,IACE,WAAW;QACX,QAAQ,CAAC,YAAY;QACrB,QAAQ,CAAC,YAAY,GAAG,WAAW;QAEnC,MAAM,IAAI,sCAA2B,CAAC;YACpC,WAAW;YACX,KAAK;YACL,QAAQ,EAAE;gBACR,IAAI;gBACJ,YAAY,EAAE,QAAQ,CAAC,YAAY;aACpC;SACF,CAAC,CAAA;IAEJ,OAAO,QAAQ,CAAC,OAAO,CAAA;AACzB,CAAC;AA/BD,0DA+BC"}

package/_esm/utils/chain.js

@@ -1,37 +0,0 @@
-import { ChainDoesNotSupportContract, ChainMismatchError, ChainNotFoundError, } from '../errors/chain.js';
-export function assertCurrentChain({ chain, currentChainId, }) {
-    if (!chain)
-        throw new ChainNotFoundError();
-    if (currentChainId !== chain.id)
-        throw new ChainMismatchError({ chain, currentChainId });
-}
-export function defineChain(chain, config = {}) {
-    const { fees = chain.fees, formatters = chain.formatters, serializers = chain.serializers, } = config;
-    return {
-        ...chain,
-        fees,
-        formatters,
-        serializers,
-    };
-}
-export function getChainContractAddress({ blockNumber, chain, contract: name, }) {
-    const contract = chain?.contracts?.[name];
-    if (!contract)
-        throw new ChainDoesNotSupportContract({
-            chain,
-            contract: { name },
-        });
-    if (blockNumber &&
-        contract.blockCreated &&
-        contract.blockCreated > blockNumber)
-        throw new ChainDoesNotSupportContract({
-            blockNumber,
-            chain,
-            contract: {
-                name,
-                blockCreated: contract.blockCreated,
-            },
-        });
-    return contract.address;
-}
-//# sourceMappingURL=chain.js.map

package/_esm/utils/chain.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"chain.js","sourceRoot":"","sources":["../../utils/chain.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAE3B,kBAAkB,EAElB,kBAAkB,GAEnB,MAAM,oBAAoB,CAAA;AAoB3B,MAAM,UAAU,kBAAkB,CAAC,EACjC,KAAK,EACL,cAAc,GACe;IAC7B,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,kBAAkB,EAAE,CAAA;IAC1C,IAAI,cAAc,KAAK,KAAK,CAAC,EAAE;QAC7B,MAAM,IAAI,kBAAkB,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAA;AAC3D,CAAC;AAED,MAAM,UAAU,WAAW,CAIzB,KAAY,EACZ,SAAkC,EAAE;IAEpC,MAAM,EACJ,IAAI,GAAG,KAAK,CAAC,IAAI,EACjB,UAAU,GAAG,KAAK,CAAC,UAAU,EAC7B,WAAW,GAAG,KAAK,CAAC,WAAW,GAChC,GAAG,MAAM,CAAA;IACV,OAAO;QACL,GAAG,KAAK;QACR,IAAI;QACJ,UAAU;QACV,WAAW;KACyC,CAAA;AACxD,CAAC;AAKD,MAAM,UAAU,uBAAuB,CAAC,EACtC,WAAW,EACX,KAAK,EACL,QAAQ,EAAE,IAAI,GAKf;IACC,MAAM,QAAQ,GAAI,KAAK,EAAE,SAA2C,EAAE,CAAC,IAAI,CAAC,CAAA;IAC5E,IAAI,CAAC,QAAQ;QACX,MAAM,IAAI,2BAA2B,CAAC;YACpC,KAAK;YACL,QAAQ,EAAE,EAAE,IAAI,EAAE;SACnB,CAAC,CAAA;IAEJ,IACE,WAAW;QACX,QAAQ,CAAC,YAAY;QACrB,QAAQ,CAAC,YAAY,GAAG,WAAW;QAEnC,MAAM,IAAI,2BAA2B,CAAC;YACpC,WAAW;YACX,KAAK;YACL,QAAQ,EAAE;gBACR,IAAI;gBACJ,YAAY,EAAE,QAAQ,CAAC,YAAY;aACpC;SACF,CAAC,CAAA;IAEJ,OAAO,QAAQ,CAAC,OAAO,CAAA;AACzB,CAAC"}

package/_types/utils/chain.d.ts

@@ -1,18 +0,0 @@
-import { type ChainDoesNotSupportContractErrorType, type ChainMismatchErrorType, type ChainNotFoundErrorType } from '../errors/chain.js';
-import type { ErrorType } from '../errors/utils.js';
-import type { Chain, ChainConfig, ChainFormatters } from '../types/chain.js';
-import type { Assign } from '../types/utils.js';
-export type AssertCurrentChainParameters = {
-    chain?: Chain;
-    currentChainId: number;
-};
-export type AssertCurrentChainErrorType = ChainNotFoundErrorType | ChainMismatchErrorType | ErrorType;
-export declare function assertCurrentChain({ chain, currentChainId, }: AssertCurrentChainParameters): void;
-export declare function defineChain<const chain extends Chain, formatters extends ChainFormatters>(chain: chain, config?: ChainConfig<formatters>): Assign<chain, ChainConfig<formatters>>;
-export type GetChainContractAddressErrorType = ChainDoesNotSupportContractErrorType;
-export declare function getChainContractAddress({ blockNumber, chain, contract: name, }: {
-    blockNumber?: bigint;
-    chain: Chain;
-    contract: string;
-}): `0x${string}`;
-//# sourceMappingURL=chain.d.ts.map

package/_types/utils/chain.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"chain.d.ts","sourceRoot":"","sources":["../../utils/chain.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,oCAAoC,EAEzC,KAAK,sBAAsB,EAE3B,KAAK,sBAAsB,EAC5B,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AACnD,OAAO,KAAK,EACV,KAAK,EACL,WAAW,EAEX,eAAe,EAChB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE/C,MAAM,MAAM,4BAA4B,GAAG;IACzC,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,cAAc,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,2BAA2B,GACnC,sBAAsB,GACtB,sBAAsB,GACtB,SAAS,CAAA;AAEb,wBAAgB,kBAAkB,CAAC,EACjC,KAAK,EACL,cAAc,GACf,EAAE,4BAA4B,GAAG,IAAI,CAIrC;AAED,wBAAgB,WAAW,CACzB,KAAK,CAAC,KAAK,SAAS,KAAK,EACzB,UAAU,SAAS,eAAe,EAElC,KAAK,EAAE,KAAK,EACZ,MAAM,GAAE,WAAW,CAAC,UAAU,CAAM,GACnC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC,CAYxC;AAED,MAAM,MAAM,gCAAgC,GAC1C,oCAAoC,CAAA;AAEtC,wBAAgB,uBAAuB,CAAC,EACtC,WAAW,EACX,KAAK,EACL,QAAQ,EAAE,IAAI,GACf,EAAE;IACD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,EAAE,KAAK,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;CACjB,iBAuBA"}

package/utils/chain.ts

@@ -1,91 +0,0 @@
-import {
-  ChainDoesNotSupportContract,
-  type ChainDoesNotSupportContractErrorType,
-  ChainMismatchError,
-  type ChainMismatchErrorType,
-  ChainNotFoundError,
-  type ChainNotFoundErrorType,
-} from '../errors/chain.js'
-import type { ErrorType } from '../errors/utils.js'
-import type {
-  Chain,
-  ChainConfig,
-  ChainContract,
-  ChainFormatters,
-} from '../types/chain.js'
-import type { Assign } from '../types/utils.js'
-
-export type AssertCurrentChainParameters = {
-  chain?: Chain
-  currentChainId: number
-}
-
-export type AssertCurrentChainErrorType =
-  | ChainNotFoundErrorType
-  | ChainMismatchErrorType
-  | ErrorType
-
-export function assertCurrentChain({
-  chain,
-  currentChainId,
-}: AssertCurrentChainParameters): void {
-  if (!chain) throw new ChainNotFoundError()
-  if (currentChainId !== chain.id)
-    throw new ChainMismatchError({ chain, currentChainId })
-}
-
-export function defineChain<
-  const chain extends Chain,
-  formatters extends ChainFormatters,
->(
-  chain: chain,
-  config: ChainConfig<formatters> = {},
-): Assign<chain, ChainConfig<formatters>> {
-  const {
-    fees = chain.fees,
-    formatters = chain.formatters,
-    serializers = chain.serializers,
-  } = config
-  return {
-    ...chain,
-    fees,
-    formatters,
-    serializers,
-  } as unknown as Assign<chain, ChainConfig<formatters>>
-}
-
-export type GetChainContractAddressErrorType =
-  ChainDoesNotSupportContractErrorType
-
-export function getChainContractAddress({
-  blockNumber,
-  chain,
-  contract: name,
-}: {
-  blockNumber?: bigint
-  chain: Chain
-  contract: string
-}) {
-  const contract = (chain?.contracts as Record<string, ChainContract>)?.[name]
-  if (!contract)
-    throw new ChainDoesNotSupportContract({
-      chain,
-      contract: { name },
-    })
-
-  if (
-    blockNumber &&
-    contract.blockCreated &&
-    contract.blockCreated > blockNumber
-  )
-    throw new ChainDoesNotSupportContract({
-      blockNumber,
-      chain,
-      contract: {
-        name,
-        blockCreated: contract.blockCreated,
-      },
-    })
-
-  return contract.address
-}