viem 0.0.0-tsc-and-nodenext-20230405154910 → 0.0.0-w-20230711200108

package/src/accounts/toAccount.ts

@@ -1,6 +1,8 @@
-import { InvalidAddressError } from '../errors/index.js'
-import type { Address } from '../types/index.js'
-import { isAddress } from '../utils/index.js'
+import type { Address } from 'abitype'
+
+import { InvalidAddressError } from '../errors/address.js'
+import { isAddress } from '../utils/address/isAddress.js'
+
 import type {
   AccountSource,
   CustomSource,

package/src/accounts/types.ts

@@ -1,11 +1,16 @@
 import type { HDKey } from '@scure/bip32'
+
 import type { Address, TypedData } from 'abitype'
+
+import type { Hash, Hex, SignableMessage } from '../types/misc.js'
 import type {
-  Hash,
-  Hex,
   TransactionSerializable,
-  TypedDataDefinition,
-} from '../types/index.js'
+  TransactionSerialized,
+} from '../types/transaction.js'
+import type { TypedDataDefinition } from '../types/typedData.js'
+import type { IsNarrowable } from '../types/utils.js'
+import type { GetTransactionType } from '../utils/transaction/getTransactionType.js'
+import type { SerializeTransactionFn } from '../utils/transaction/serializeTransaction.js'
 
 export type Account<TAddress extends Address = Address> =
   | JsonRpcAccount<TAddress>
@@ -14,8 +19,20 @@ export type Account<TAddress extends Address = Address> =
 export type AccountSource = Address | CustomSource
 export type CustomSource = {
   address: Address
-  signMessage: ({ message }: { message: string }) => Promise<Hash>
-  signTransaction: (transaction: TransactionSerializable) => Promise<Hash>
+  signMessage: ({ message }: { message: SignableMessage }) => Promise<Hash>
+  signTransaction: <TTransactionSerializable extends TransactionSerializable>(
+    transaction: TTransactionSerializable,
+    args?: {
+      serializer?: SerializeTransactionFn<TTransactionSerializable>
+    },
+  ) => Promise<
+    IsNarrowable<
+      TransactionSerialized<GetTransactionType<TTransactionSerializable>>,
+      Hash
+    > extends true
+      ? TransactionSerialized<GetTransactionType<TTransactionSerializable>>
+      : Hash
+  >
   signTypedData: <
     TTypedData extends TypedData | { [key: string]: unknown },
     TPrimaryType extends string = string,

package/src/accounts/utils/parseAccount.ts

@@ -1,4 +1,5 @@
-import type { Address } from '../../types/index.js'
+import type { Address } from 'abitype'
+
 import type { Account } from '../types.js'
 
 export function parseAccount(account: Address | Account): Account {

package/src/accounts/utils/publicKeyToAddress.ts

@@ -1,6 +1,8 @@
-import type { Address, Hex } from '../../types/index.js'
-import { keccak256 } from '../../utils/index.js'
-import { checksumAddress } from '../../utils/address/index.js'
+import type { Address } from 'abitype'
+
+import type { Hex } from '../../types/misc.js'
+import { checksumAddress } from '../../utils/address/getAddress.js'
+import { keccak256 } from '../../utils/hash/keccak256.js'
 
 /**
  * @description Converts an ECDSA public key to an address.

package/src/accounts/utils/sign.ts

@@ -1,7 +1,7 @@
 import { secp256k1 } from '@noble/curves/secp256k1'
 
-import type { Hex, Signature } from '../../types/index.js'
-import { toHex } from '../../utils/index.js'
+import type { Hex, Signature } from '../../types/misc.js'
+import { toHex } from '../../utils/encoding/toHex.js'
 
 export type SignParameters = {
   hash: Hex

package/src/accounts/utils/signMessage.ts

@@ -1,11 +1,12 @@
-import type { Hex } from '../../types/index.js'
-import { hashMessage } from '../../utils/index.js'
+import type { Hex, SignableMessage } from '../../types/misc.js'
+import { hashMessage } from '../../utils/signature/hashMessage.js'
+
 import { sign } from './sign.js'
 import { signatureToHex } from './signatureToHex.js'
 
 export type SignMessageParameters = {
   /** The message to sign. */
-  message: string
+  message: SignableMessage
   /** The private key to sign with. */
   privateKey: Hex
 }

package/src/accounts/utils/signTransaction.ts

@@ -1,11 +1,15 @@
+import type { Hex } from '../../types/misc.js'
 import type {
-  Hex,
   TransactionSerializable,
   TransactionSerialized,
-  TransactionType,
-} from '../../types/index.js'
-import { keccak256, serializeTransaction } from '../../utils/index.js'
-import type { GetTransactionType } from '../../utils/index.js'
+} from '../../types/transaction.js'
+import { keccak256 } from '../../utils/hash/keccak256.js'
+import type { GetTransactionType } from '../../utils/transaction/getTransactionType.js'
+import {
+  type SerializeTransactionFn,
+  serializeTransaction,
+} from '../../utils/transaction/serializeTransaction.js'
+
 import { sign } from './sign.js'
 
 export type SignTransactionArgs<
@@ -13,23 +17,29 @@ export type SignTransactionArgs<
 > = {
   privateKey: Hex
   transaction: TTransactionSerializable
+  serializer?: SerializeTransactionFn<
+    TransactionSerializable & TTransactionSerializable
+  >
 }
 export type SignTransactionReturnType<
   TTransactionSerializable extends TransactionSerializable = TransactionSerializable,
-  TTransactionType extends TransactionType = GetTransactionType<TTransactionSerializable>,
-> = TransactionSerialized<TTransactionType>
+> = TransactionSerialized<GetTransactionType<TTransactionSerializable>>
 
 export async function signTransaction<
   TTransactionSerializable extends TransactionSerializable,
 >({
   privateKey,
   transaction,
+  serializer = serializeTransaction,
 }: SignTransactionArgs<TTransactionSerializable>): Promise<
   SignTransactionReturnType<TTransactionSerializable>
 > {
   const signature = await sign({
-    hash: keccak256(serializeTransaction(transaction)),
+    hash: keccak256(serializer(transaction)),
     privateKey,
   })
-  return serializeTransaction(transaction, signature)
+  return serializer(
+    transaction,
+    signature,
+  ) as SignTransactionReturnType<TTransactionSerializable>
 }

package/src/accounts/utils/signTypedData.ts

@@ -1,8 +1,12 @@
 import type { TypedData } from 'abitype'
 
-import type { Hex, TypedDataDefinition } from '../../types/index.js'
-import type { HashTypedDataParameters } from '../../utils/index.js'
-import { hashTypedData } from '../../utils/index.js'
+import type { Hex } from '../../types/misc.js'
+import type { TypedDataDefinition } from '../../types/typedData.js'
+import {
+  type HashTypedDataParameters,
+  hashTypedData,
+} from '../../utils/signature/hashTypedData.js'
+
 import { sign } from './sign.js'
 import { signatureToHex } from './signatureToHex.js'
 

package/src/accounts/utils/signatureToHex.ts

@@ -1,7 +1,8 @@
 import { secp256k1 } from '@noble/curves/secp256k1'
 
-import type { Hex, Signature } from '../../types/index.js'
-import { hexToBigInt, toHex } from '../../utils/index.js'
+import type { Hex, Signature } from '../../types/misc.js'
+import { hexToBigInt } from '../../utils/encoding/fromHex.js'
+import { toHex } from '../../utils/encoding/toHex.js'
 
 export function signatureToHex({ r, s, v }: Signature): Hex {
   return `0x${new secp256k1.Signature(

package/src/actions/ens/getEnsAddress.ts

@@ -1,25 +1,34 @@
-import type { PublicClient, Transport } from '../../clients/index.js'
+import type { Address } from 'abitype'
+
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
 import {
   singleAddressResolverAbi,
   universalResolverAbi,
 } from '../../constants/abis.js'
-import type { Address, Chain, Prettify } from '../../types/index.js'
 import {
-  decodeFunctionResult,
-  encodeFunctionData,
-  getChainContractAddress,
-  toHex,
-  trim,
-} from '../../utils/index.js'
-import { namehash, packetToBytes } from '../../utils/ens/index.js'
-import { readContract } from '../public/index.js'
-import type { ReadContractParameters } from '../public/index.js'
+  ContractFunctionExecutionError,
+  ContractFunctionRevertedError,
+} from '../../errors/contract.js'
+import type { Chain } from '../../types/chain.js'
+import type { Prettify } from '../../types/utils.js'
+import { decodeFunctionResult } from '../../utils/abi/decodeFunctionResult.js'
+import { encodeFunctionData } from '../../utils/abi/encodeFunctionData.js'
+import { getChainContractAddress } from '../../utils/chain.js'
+import { trim } from '../../utils/data/trim.js'
+import { toHex } from '../../utils/encoding/toHex.js'
+import { namehash } from '../../utils/ens/namehash.js'
+import { packetToBytes } from '../../utils/ens/packetToBytes.js'
+import {
+  type ReadContractParameters,
+  readContract,
+} from '../public/readContract.js'
 
 export type GetEnsAddressParameters = Prettify<
   Pick<ReadContractParameters, 'blockNumber' | 'blockTag'> & {
-    /** ENS name to get address. */
+    /** Name to get the address for. */
     name: string
-    /** Address of ENS Universal Resolver Contract */
+    /** Address of ENS Universal Resolver Contract. */
     universalResolverAddress?: Address
   }
 >
@@ -27,13 +36,35 @@ export type GetEnsAddressParameters = Prettify<
 export type GetEnsAddressReturnType = Address | null
 
 /**
- * @description Gets address for ENS name.
+ * Gets address for ENS name.
+ *
+ * - Docs: https://viem.sh/docs/ens/actions/getEnsAddress.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
+ *
+ * Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract.
+ *
+ * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetEnsAddressParameters}
+ * @returns Address for ENS name or `null` if not found. {@link GetEnsAddressReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getEnsAddress, normalize } from 'viem/ens'
  *
- * - Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract.
- * - Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const ensAddress = await getEnsAddress(client, {
+ *   name: normalize('wagmi-dev.eth'),
+ * })
+ * // '0xd2135CfB216b74109775236E36d4b433F1DF507B'
  */
 export async function getEnsAddress<TChain extends Chain | undefined,>(
-  client: PublicClient<Transport, TChain>,
+  client: Client<Transport, TChain>,
   {
     blockNumber,
     blockTag,
@@ -55,29 +86,40 @@ export async function getEnsAddress<TChain extends Chain | undefined,>(
     })
   }
 
-  const res = await readContract(client, {
-    address: universalResolverAddress,
-    abi: universalResolverAbi,
-    functionName: 'resolve',
-    args: [
-      toHex(packetToBytes(name)),
-      encodeFunctionData({
-        abi: singleAddressResolverAbi,
-        functionName: 'addr',
-        args: [namehash(name)],
-      }),
-    ],
-    blockNumber,
-    blockTag,
-  })
+  try {
+    const res = await readContract(client, {
+      address: universalResolverAddress,
+      abi: universalResolverAbi,
+      functionName: 'resolve',
+      args: [
+        toHex(packetToBytes(name)),
+        encodeFunctionData({
+          abi: singleAddressResolverAbi,
+          functionName: 'addr',
+          args: [namehash(name)],
+        }),
+      ],
+      blockNumber,
+      blockTag,
+    })
 
-  if (res[0] === '0x') return null
+    if (res[0] === '0x') return null
 
-  const address = decodeFunctionResult({
-    abi: singleAddressResolverAbi,
-    functionName: 'addr',
-    data: res[0],
-  })
+    const address = decodeFunctionResult({
+      abi: singleAddressResolverAbi,
+      functionName: 'addr',
+      data: res[0],
+    })
 
-  return trim(address) === '0x0' ? null : address
+    return trim(address) === '0x00' ? null : address
+  } catch (err) {
+    if (err instanceof ContractFunctionExecutionError) {
+      const reason = (err.cause as ContractFunctionRevertedError)?.reason
+      if (
+        reason?.includes('Wildcard on non-extended resolvers is not supported')
+      )
+        return null
+    }
+    throw err
+  }
 }

package/src/actions/ens/getEnsAvatar.ts

@@ -1,12 +1,15 @@
-import type { PublicClient, Transport } from '../../clients/index.js'
-import type { AssetGatewayUrls, Chain, Prettify } from '../../types/index.js'
-import { parseAvatarRecord } from '../../utils/ens/index.js'
-import { getEnsText } from './getEnsText.js'
-import type { GetEnsTextParameters } from './getEnsText.js'
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import type { AssetGatewayUrls } from '../../types/ens.js'
+import type { Prettify } from '../../types/utils.js'
+import { parseAvatarRecord } from '../../utils/ens/avatar/parseAvatarRecord.js'
+
+import { type GetEnsTextParameters, getEnsText } from './getEnsText.js'
 
 export type GetEnsAvatarParameters = Prettify<
   Omit<GetEnsTextParameters, 'key'> & {
-    /** Custom gateways to use */
+    /** Gateway urls to resolve IPFS and/or Arweave assets. */
     gatewayUrls?: AssetGatewayUrls
   }
 >
@@ -14,10 +17,35 @@ export type GetEnsAvatarParameters = Prettify<
 export type GetEnsAvatarReturnType = string | null
 
 /**
- * @description Gets avatar URI for ENS name.
+ * Gets the avatar of an ENS name.
+ *
+ * - Docs: https://viem.sh/docs/ens/actions/getEnsAvatar.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
+ *
+ * Calls [`getEnsText`](https://viem.sh/docs/ens/actions/getEnsText.html) with `key` set to `'avatar'`.
+ *
+ * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetEnsAvatarParameters}
+ * @returns Avatar URI or `null` if not found. {@link GetEnsAvatarReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getEnsAvatar, normalize } from 'viem/ens'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const ensAvatar = await getEnsAvatar(client, {
+ *   name: normalize('wagmi-dev.eth'),
+ * })
+ * // 'https://ipfs.io/ipfs/Qma8mnp6xV3J2cRNf3mTth5C8nV11CAnceVinc3y8jSbio'
  */
 export async function getEnsAvatar<TChain extends Chain | undefined>(
-  client: PublicClient<Transport, TChain>,
+  client: Client<Transport, TChain>,
   {
     blockNumber,
     blockTag,

package/src/actions/ens/getEnsName.ts

@@ -1,12 +1,21 @@
-import type { PublicClient, Transport } from '../../clients/index.js'
-import { panicReasons } from '../../constants/index.js'
-import type { ContractFunctionRevertedError } from '../../errors/index.js'
-import { ContractFunctionExecutionError } from '../../errors/index.js'
-import type { Address, Chain, Prettify } from '../../types/index.js'
-import { getChainContractAddress, toHex } from '../../utils/index.js'
-import { packetToBytes } from '../../utils/ens/index.js'
-import { readContract } from '../public/index.js'
-import type { ReadContractParameters } from '../public/index.js'
+import type { Address } from 'abitype'
+
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import { panicReasons } from '../../constants/solidity.js'
+import {
+  ContractFunctionExecutionError,
+  type ContractFunctionRevertedError,
+} from '../../errors/contract.js'
+import type { Chain } from '../../types/chain.js'
+import type { Prettify } from '../../types/utils.js'
+import { getChainContractAddress } from '../../utils/chain.js'
+import { toHex } from '../../utils/encoding/toHex.js'
+import { packetToBytes } from '../../utils/ens/packetToBytes.js'
+import {
+  type ReadContractParameters,
+  readContract,
+} from '../public/readContract.js'
 
 export type GetEnsNameParameters = Prettify<
   Pick<ReadContractParameters, 'blockNumber' | 'blockTag'> & {
@@ -20,18 +29,33 @@ export type GetEnsNameParameters = Prettify<
 export type GetEnsNameReturnType = string | null
 
 /**
- * @description Gets primary name for specified address.
+ * Gets primary name for specified address.
+ *
+ * - Docs: https://viem.sh/docs/ens/actions/getEnsName.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
+ *
+ * Calls `reverse(bytes)` on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name.
  *
- * - Calls `reverse(bytes)` on ENS Universal Resolver Contract.
+ * @param client - Client to use
+ * @param parameters - {@link GetEnsNameParameters}
+ * @returns Name or `null` if not found. {@link GetEnsNameReturnType}
  *
  * @example
- * const ensName = await getEnsName(publicClient, {
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getEnsName } from 'viem/ens'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const ensName = await getEnsName(client, {
  *   address: '0xd2135CfB216b74109775236E36d4b433F1DF507B',
  * })
  * // 'wagmi-dev.eth'
  */
 export async function getEnsName<TChain extends Chain | undefined>(
-  client: PublicClient<Transport, TChain>,
+  client: Client<Transport, TChain>,
   {
     address,
     blockNumber,

package/src/actions/ens/getEnsResolver.ts

@@ -1,15 +1,22 @@
-import type { PublicClient, Transport } from '../../clients/index.js'
-import type { Address, Chain, Prettify } from '../../types/index.js'
-import { getChainContractAddress, toHex } from '../../utils/index.js'
-import { packetToBytes } from '../../utils/ens/index.js'
-import { readContract } from '../public/index.js'
-import type { ReadContractParameters } from '../public/index.js'
+import type { Address } from 'abitype'
+
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
+import type { Chain } from '../../types/chain.js'
+import type { Prettify } from '../../types/utils.js'
+import { getChainContractAddress } from '../../utils/chain.js'
+import { toHex } from '../../utils/encoding/toHex.js'
+import { packetToBytes } from '../../utils/ens/packetToBytes.js'
+import {
+  type ReadContractParameters,
+  readContract,
+} from '../public/readContract.js'
 
 export type GetEnsResolverParameters = Prettify<
   Pick<ReadContractParameters, 'blockNumber' | 'blockTag'> & {
-    /** ENS name to get resolver. */
+    /** Name to get the address for. */
     name: string
-    /** Address of ENS Universal Resolver Contract */
+    /** Address of ENS Universal Resolver Contract. */
     universalResolverAddress?: Address
   }
 >
@@ -17,10 +24,35 @@ export type GetEnsResolverParameters = Prettify<
 export type GetEnsResolverReturnType = Address
 
 /**
- * @description Gets resolver for ENS name.
+ * Gets resolver for ENS name.
+ *
+ * - Docs: https://viem.sh/docs/ens/actions/getEnsResolver.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
+ *
+ * Calls `findResolver(bytes)` on ENS Universal Resolver Contract to retrieve the resolver of an ENS name.
+ *
+ * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetEnsResolverParameters}
+ * @returns Address for ENS resolver. {@link GetEnsResolverReturnType}
+ *
+ * @example
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getEnsResolver, normalize } from 'viem/ens'
+ *
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const resolverAddress = await getEnsResolver(client, {
+ *   name: normalize('wagmi-dev.eth'),
+ * })
+ * // '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41'
  */
 export async function getEnsResolver<TChain extends Chain | undefined>(
-  client: PublicClient<Transport, TChain>,
+  client: Client<Transport, TChain>,
   {
     blockNumber,
     blockTag,

package/src/actions/ens/getEnsText.ts

@@ -1,21 +1,26 @@
-import type { PublicClient, Transport } from '../../clients/index.js'
+import type { Address } from 'abitype'
+
+import type { Client } from '../../clients/createClient.js'
+import type { Transport } from '../../clients/transports/createTransport.js'
 import { textResolverAbi, universalResolverAbi } from '../../constants/abis.js'
-import type { Address, Chain, Prettify } from '../../types/index.js'
+import type { Chain } from '../../types/chain.js'
+import type { Prettify } from '../../types/utils.js'
+import { decodeFunctionResult } from '../../utils/abi/decodeFunctionResult.js'
+import { encodeFunctionData } from '../../utils/abi/encodeFunctionData.js'
+import { getChainContractAddress } from '../../utils/chain.js'
+import { toHex } from '../../utils/encoding/toHex.js'
+import { namehash } from '../../utils/ens/namehash.js'
+import { packetToBytes } from '../../utils/ens/packetToBytes.js'
 import {
-  decodeFunctionResult,
-  encodeFunctionData,
-  getChainContractAddress,
-  toHex,
-} from '../../utils/index.js'
-import { namehash, packetToBytes } from '../../utils/ens/index.js'
-import { readContract } from '../public/index.js'
-import type { ReadContractParameters } from '../public/index.js'
+  type ReadContractParameters,
+  readContract,
+} from '../public/readContract.js'
 
 export type GetEnsTextParameters = Prettify<
   Pick<ReadContractParameters, 'blockNumber' | 'blockTag'> & {
-    /** ENS name to get ENS avatar for. */
+    /** ENS name to get Text for. */
     name: string
-    /** Text record to retrieve */
+    /** Text record to retrieve. */
     key: string
     /** Address of ENS Universal Resolver Contract. */
     universalResolverAddress?: Address
@@ -25,22 +30,36 @@ export type GetEnsTextParameters = Prettify<
 export type GetEnsTextReturnType = string | null
 
 /**
- * @description Gets text record for ENS name.
+ * Gets a text record for specified ENS name.
+ *
+ * - Docs: https://viem.sh/docs/ens/actions/getEnsResolver.html
+ * - Examples: https://stackblitz.com/github/wagmi-dev/viem/tree/main/examples/ens
+ *
+ * Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract.
  *
- * - Calls `resolve(bytes, bytes)` on ENS Universal Resolver Contract.
- * - Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.
+ * Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to [normalize ENS names](https://docs.ens.domains/contract-api-reference/name-processing#normalising-names) with [UTS-46 normalization](https://unicode.org/reports/tr46) before passing them to `getEnsAddress`. You can use the built-in [`normalize`](https://viem.sh/docs/ens/utilities/normalize.html) function for this.
+ *
+ * @param client - Client to use
+ * @param parameters - {@link GetEnsTextParameters}
+ * @returns Address for ENS resolver. {@link GetEnsTextReturnType}
  *
  * @example
- * import { normalize } from 'viem/ens'
+ * import { createPublicClient, http } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { getEnsText, normalize } from 'viem/ens'
  *
- * const twitterRecord = await getEnsText(publicClient, {
+ * const client = createPublicClient({
+ *   chain: mainnet,
+ *   transport: http(),
+ * })
+ * const twitterRecord = await getEnsText(client, {
  *   name: normalize('wagmi-dev.eth'),
  *   key: 'com.twitter',
  * })
  * // 'wagmi_sh'
  */
 export async function getEnsText<TChain extends Chain | undefined>(
-  client: PublicClient<Transport, TChain>,
+  client: Client<Transport, TChain>,
   {
     blockNumber,
     blockTag,