@ensdomains/ensjs 3.0.0-beta.5 → 3.0.0-beta.6

package/src/clients/decorators/wallet.ts

@@ -1,5 +1,9 @@
 import type { Account, Transport, WalletClient } from 'viem'
 import type { ChainWithEns } from '../../contracts/consts.js'
+import clearRecords, {
+  type ClearRecordsParameters,
+  type ClearRecordsReturnType,
+} from '../../functions/wallet/clearRecords.js'
 import commitName, {
   type CommitNameParameters,
   type CommitNameReturnType,
@@ -73,6 +77,35 @@ export type EnsWalletActions<
   TChain extends ChainWithEns,
   TAccount extends Account | undefined,
 > = {
+  /**
+   * Clears the records for a name on a resolver.
+   * @param parameters - {@link ClearRecordsParameters}
+   * @returns Transaction hash. {@link ClearRecordsReturnType}
+   *
+   * @example
+   * import { createWalletClient, custom } from 'viem'
+   * import { mainnet } from 'viem/chains'
+   * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+   *
+   * const wallet = createWalletClient({
+   *   chain: addEnsContracts(mainnet),
+   *   transport: custom(window.ethereum),
+   * }).extend(ensWalletActions)
+   * const hash = await wallet.clearRecords({
+   *   name: 'ens.eth',
+   *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+   * })
+   * // 0x...
+   */
+  clearRecords: ({
+    name,
+    resolverAddress,
+    ...txArgs
+  }: ClearRecordsParameters<
+    TChain,
+    TAccount,
+    TChain
+  >) => Promise<ClearRecordsReturnType>
   /**
    * Commits a name to be registered
    * @param parameters - {@link CommitNameParameters}
@@ -81,7 +114,8 @@ export type EnsWalletActions<
    * @example
    * import { createWalletClient, custom } from 'viem'
    * import { mainnet } from 'viem/chains'
-   * import { addEnsContracts, ensWalletActions, randomSecret } from '@ensdomains/ensjs'
+   * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+   * import { randomSecret } from '@ensdomains/ensjs/utils'
    *
    * const wallet = createWalletClient({
    *   chain: addEnsContracts(mainnet),
@@ -183,7 +217,8 @@ export type EnsWalletActions<
    * @example
    * import { createPublicClient, createWalletClient, http, custom } from 'viem'
    * import { mainnet } from 'viem/chains'
-   * import { addEnsContracts, ensPublicActions, ensWalletActions, randomSecret } from '@ensdomains/ensjs'
+   * import { addEnsContracts, ensPublicActions, ensWalletActions } from '@ensdomains/ensjs'
+   * import { randomSecret } from '@ensdomains/ensjs/utils'
    *
    * const mainnetWithEns = addEnsContracts(mainnet)
    * const client = createPublicClient({
@@ -279,7 +314,8 @@ export type EnsWalletActions<
    * import abi from './abi.json'
    * import { createWalletClient, custom } from 'viem'
    * import { mainnet } from 'viem/chains'
-   * import { addEnsContracts, ensWalletActions, encodeAbi } from '@ensdomains/ensjs'
+   * import { addEnsContracts, ensWalletActions } from '@ensdomains/ensjs'
+   * import { encodeAbi } from '@ensdomains/ensjs/utils'
    *
    * const wallet = createWalletClient({
    *   chain: addEnsContracts(mainnet),
@@ -492,6 +528,7 @@ export type EnsWalletActions<
   setRecords: ({
     name,
     resolverAddress,
+    // eslint-disable-next-line @typescript-eslint/no-shadow
     clearRecords,
     contentHash,
     texts,
@@ -687,6 +724,7 @@ export const ensWalletActions = <
 >(
   client: WalletClient<TTransport, TChain, TAccount>,
 ): EnsWalletActions<TChain, TAccount> => ({
+  clearRecords: (parameters) => clearRecords(client, parameters),
   commitName: (parameters) => commitName(client, parameters),
   createSubname: (parameters) => createSubname(client, parameters),
   deleteSubname: (parameters) => deleteSubname(client, parameters),

package/src/contracts/consts.ts

@@ -79,7 +79,7 @@ export const addresses = {
       address: '0x114D4603199df73e7D157787f8778E21fCd13066',
     },
     ensPublicResolver: {
-      address: '0xd7a4F6473f32aC2Af804B3686AE8F19E48B8fF5f',
+      address: '0xd7a4F6473f32aC2Af804B3686AE8F1932bC35750',
     },
     ensReverseRegistrar: {
       address: '0x6d9F26FfBcF1c6f0bAe9F2C1f7fBe8eE6B1d8d4d',

package/src/errors/version.ts

@@ -1 +1 @@
-export const version = 'v3.0.0-beta.5'
+export const version = 'v3.0.0-beta.6'

package/src/functions/dns/getDnsImportData.ts

@@ -51,7 +51,8 @@ const encodeProofs = (
  * @example
  * import { createPublicClient, http } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, getDnsImportData } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getDnsImportData } from '@ensdomains/ensjs/dns'
  *
  * const client = createPublicClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/dns/getDnsOwner.ts

@@ -82,7 +82,7 @@ type DnsResponse = {
  * @returns Address of DNS owner. {@link GetDnsOwnerReturnType}
  *
  * @example
- * import { getDnsOwner } from '@ensdomains/ensjs'
+ * import { getDnsOwner } from '@ensdomains/ensjs/dns'
  *
  * const owner = await getDnsOwner({ name: 'ens.domains' })
  * // '0xb8c2C29ee19D8307cb7255e1Cd9CbDE883A267d5'

package/src/functions/dns/importDnsName.ts

@@ -129,7 +129,8 @@ export const makeFunctionData = <
  * @example
  * import { createPublicClient, createWalletClient, http, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, getDnsImportData, importDnsName } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getDnsImportData, importDnsName } from '@ensdomains/ensjs/dns'
  *
  * const mainnetWithEns = addEnsContracts(mainnet)
  * const client = createPublicClient({

package/src/functions/public/_getAddr.ts

@@ -15,6 +15,7 @@ import type {
 } from '../../types.js'
 import { EMPTY_ADDRESS } from '../../utils/consts.js'
 import { generateFunction } from '../../utils/generateFunction.js'
+import { normaliseCoinId } from '../../utils/normaliseCoinId.js'
 
 export type InternalGetAddrParameters = {
   /** Name to get the address record for */
@@ -31,7 +32,11 @@ const encode = (
   _client: ClientWithEns,
   { name, coin = 60, bypassFormat }: InternalGetAddrParameters,
 ): SimpleTransactionRequest => {
-  if (coin === 60 || coin === '60') {
+  const normalisedCoin = normaliseCoinId(coin)
+  if (
+    (normalisedCoin.type === 'id' && normalisedCoin.value === 60) ||
+    (normalisedCoin.type === 'name' && normalisedCoin.value === 'ETH')
+  ) {
     return {
       to: EMPTY_ADDRESS,
       data: encodeFunctionData({
@@ -53,11 +58,12 @@ const encode = (
     }
   }
   const formatter =
-    typeof coin === 'string' && Number.isNaN(parseInt(coin))
-      ? formatsByName[coin]
-      : formatsByCoinType[typeof coin === 'number' ? coin : parseInt(coin)]
+    normalisedCoin.type === 'name'
+      ? formatsByName[normalisedCoin.value]
+      : formatsByCoinType[normalisedCoin.value]
 
-  if (!formatter) throw new CoinFormatterNotFoundError({ coinType: coin })
+  if (!formatter)
+    throw new CoinFormatterNotFoundError({ coinType: normalisedCoin.value })
 
   return {
     to: EMPTY_ADDRESS,
@@ -72,21 +78,23 @@ const encode = (
 const decode = async (
   _client: ClientWithEns,
   data: Hex,
-  { coin }: InternalGetAddrParameters,
+  { coin = 60 }: InternalGetAddrParameters,
 ): Promise<InternalGetAddrReturnType> => {
   if (data === '0x') return null
-  if (!coin) {
-    coin = 60
-  }
+
+  const normalisedCoin = normaliseCoinId(coin)
 
   const formatter =
-    typeof coin === 'string' && Number.isNaN(parseInt(coin))
-      ? formatsByName[coin]
-      : formatsByCoinType[typeof coin === 'number' ? coin : parseInt(coin)]
+    normalisedCoin.type === 'name'
+      ? formatsByName[normalisedCoin.value]
+      : formatsByCoinType[normalisedCoin.value]
 
   let response: Hex
 
-  if (coin === 60 || coin === '60') {
+  if (
+    (normalisedCoin.type === 'id' && normalisedCoin.value === 60) ||
+    (normalisedCoin.type === 'name' && normalisedCoin.value === 'ETH')
+  ) {
     response = decodeFunctionResult({
       abi: publicResolverSingleAddrSnippet,
       functionName: 'addr',

package/src/functions/public/batch.ts

@@ -75,7 +75,8 @@ type BatchableFunctionObject = GeneratedFunction<typeof encode, typeof decode>
  * @example
  * import { createPublicClient, http } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, batch, getTextRecord, getAddressRecord } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { batch, getTextRecord, getAddressRecord } from '@ensdomains/ensjs/public'
  *
  * const client = createPublicClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/public/getAbiRecord.ts

@@ -47,7 +47,8 @@ type BatchableFunctionObject = GeneratedFunction<typeof encode, typeof decode>
  * @example
  * import { createPublicClient, http } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, getAbiRecord } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getAbiRecord } from '@ensdomains/ensjs/public'
  *
  * const client = createPublicClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/public/getAddressRecord.ts

@@ -48,7 +48,8 @@ type BatchableFunctionObject = GeneratedFunction<typeof encode, typeof decode>
  * @example
  * import { createPublicClient, http } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, getAddressRecord } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getAddressRecord } from '@ensdomains/ensjs/public'
  *
  * const client = createPublicClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/public/getAvailable.ts

@@ -73,7 +73,8 @@ type BatchableFunctionObject = GeneratedFunction<typeof encode, typeof decode>
  * @example
  * import { createPublicClient, http } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, getAvailable } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getAvailable } from '@ensdomains/ensjs/public'
  *
  * const client = createPublicClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/public/getContentHashRecord.ts

@@ -49,7 +49,8 @@ type BatchableFunctionObject = GeneratedFunction<typeof encode, typeof decode>
  * @example
  * import { createPublicClient, http } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, getContentHashRecord } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getContentHashRecord } from '@ensdomains/ensjs/public'
  *
  * const client = createPublicClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/public/getExpiry.ts

@@ -181,7 +181,8 @@ type BatchableFunctionObject = GeneratedFunction<typeof encode, typeof decode>
  * @example
  * import { createPublicClient, http } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, getExpiry } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getExpiry } from '@ensdomains/ensjs/public'
  *
  * const client = createPublicClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/public/getName.ts

@@ -110,7 +110,8 @@ type BatchableFunctionObject = GeneratedFunction<typeof encode, typeof decode>
  * @example
  * import { createPublicClient, http } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, getName } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getName } from '@ensdomains/ensjs/public'
  *
  * const client = createPublicClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/public/getOwner.ts

@@ -3,10 +3,7 @@ import type { ClientWithEns } from '../../contracts/consts.js'
 import { getChainContractAddress } from '../../contracts/getChainContractAddress.js'
 import type { SimpleTransactionRequest } from '../../types.js'
 import { EMPTY_ADDRESS } from '../../utils/consts.js'
-import {
-  generateFunction,
-  type GeneratedFunction,
-} from '../../utils/generateFunction.js'
+import { generateFunction } from '../../utils/generateFunction.js'
 import { namehash as makeNamehash } from '../../utils/normalise.js'
 import {
   ownerFromContract,
@@ -15,11 +12,13 @@ import {
 import { checkIsDotEth } from '../../utils/validation.js'
 import multicallWrapper from './multicallWrapper.js'
 
-export type GetOwnerParameters = {
+export type GetOwnerParameters<
+  TContract extends OwnerContract | undefined = undefined,
+> = {
   /** Name to get owner for */
   name: string
   /** Optional specific contract to get ownership value from */
-  contract?: OwnerContract
+  contract?: TContract
 }
 
 type BaseGetOwnerReturnType = {
@@ -55,19 +54,22 @@ type UnwrappedOwnership = {
   ownershipLevel: 'registry'
 }
 
-export type GetOwnerReturnType =
+export type GetOwnerReturnType<
+  TContract extends OwnerContract | undefined = undefined,
+> =
   | (BaseGetOwnerReturnType &
-      (
-        | RegistrarOnlyOwnership
-        | WrappedOwnership
-        | UnwrappedEth2ldOwnership
-        | UnwrappedOwnership
-      ))
+      (TContract extends 'registrar'
+        ? RegistrarOnlyOwnership
+        : TContract extends 'nameWrapper'
+        ? WrappedOwnership
+        : TContract extends 'registry'
+        ? UnwrappedOwnership
+        : WrappedOwnership | UnwrappedEth2ldOwnership | UnwrappedOwnership))
   | null
 
-const encode = (
+const encode = <TContract extends OwnerContract | undefined = undefined>(
   client: ClientWithEns,
-  { name, contract }: GetOwnerParameters,
+  { name, contract }: GetOwnerParameters<TContract>,
 ): SimpleTransactionRequest => {
   const namehash = makeNamehash(name)
   const labels = name.split('.')
@@ -102,13 +104,13 @@ const encode = (
 }
 
 const addressDecode = (data: Hex) =>
-  decodeAbiParameters([{ type: 'address' }], data)[0]
+  decodeAbiParameters([{ type: 'address' }], data)[0] as Address
 
-const decode = async (
+const decode = async <TContract extends OwnerContract | undefined = undefined>(
   client: ClientWithEns,
   data: Hex | BaseError,
-  { name, contract }: GetOwnerParameters,
-): Promise<GetOwnerReturnType> => {
+  { name, contract }: GetOwnerParameters<TContract>,
+): Promise<GetOwnerReturnType<TContract>> => {
   if (typeof data === 'object') throw data
   const labels = name.split('.')
   if (contract || labels.length === 1) {
@@ -117,12 +119,12 @@ const decode = async (
       return {
         ownershipLevel: 'registrar',
         registrant: singleOwner,
-      } as RegistrarOnlyOwnership
+      } as GetOwnerReturnType<TContract>
     }
     return {
       ownershipLevel: contract || 'registry',
       owner: singleOwner,
-    } as UnwrappedOwnership | WrappedOwnership
+    } as GetOwnerReturnType<TContract>
   }
 
   const result = await multicallWrapper.decode(client, data, [])
@@ -150,7 +152,7 @@ const decode = async (
       return {
         owner: nameWrapperOwner,
         ownershipLevel: 'nameWrapper',
-      } as WrappedOwnership
+      } as GetOwnerReturnType<TContract>
     }
     // if there is a registrar owner, then it's not a subdomain but we have also passed the namewrapper clause
     // this means that it's an unwrapped second-level name
@@ -161,7 +163,7 @@ const decode = async (
         registrant: registrarOwner!,
         owner: registryOwner!,
         ownershipLevel: 'registrar',
-      } as UnwrappedEth2ldOwnership
+      } as GetOwnerReturnType<TContract>
     }
     if (registryOwner !== EMPTY_ADDRESS) {
       // if there is no registrar owner, but the label length is two, then the domain is an expired 2LD .eth
@@ -171,7 +173,7 @@ const decode = async (
           registrant: null,
           owner: registryOwner,
           ownershipLevel: 'registrar',
-        } as UnwrappedEth2ldOwnership
+        } as GetOwnerReturnType<TContract>
       }
       // this means that the subname is wrapped
       if (
@@ -182,13 +184,13 @@ const decode = async (
         return {
           owner: nameWrapperOwner,
           ownershipLevel: 'nameWrapper',
-        } as WrappedOwnership
+        } as GetOwnerReturnType<TContract>
       }
       // unwrapped subnames do not have NFTs associated, so do not have a registrant
       return {
         owner: registryOwner,
         ownershipLevel: 'registry',
-      } as UnwrappedOwnership
+      } as GetOwnerReturnType<TContract>
     }
     // .eth names with no registrar owner are either unregistered or expired
     return null
@@ -206,7 +208,7 @@ const decode = async (
     return {
       owner: nameWrapperOwner,
       ownershipLevel: 'nameWrapper',
-    } as WrappedOwnership
+    } as GetOwnerReturnType<TContract>
   }
 
   // for unwrapped non .eth names, the owner is the registry owner
@@ -214,14 +216,30 @@ const decode = async (
     return {
       owner: registryOwner,
       ownershipLevel: 'registry',
-    } as UnwrappedOwnership
+    } as GetOwnerReturnType<TContract>
   }
 
   // for anything else, return
   return null
 }
 
-type BatchableFunctionObject = GeneratedFunction<typeof encode, typeof decode>
+type EncoderFunction = typeof encode
+type DecoderFunction = typeof decode
+
+type BatchableFunctionObject = {
+  encode: EncoderFunction
+  decode: DecoderFunction
+  batch: <
+    TContract extends OwnerContract | undefined = undefined,
+    TParams extends GetOwnerParameters<TContract> = GetOwnerParameters<TContract>,
+  >(
+    args: TParams,
+  ) => {
+    args: [TParams]
+    encode: EncoderFunction
+    decode: typeof decode<TContract>
+  }
+}
 
 /**
  * Gets the owner(s) of a name.
@@ -232,7 +250,8 @@ type BatchableFunctionObject = GeneratedFunction<typeof encode, typeof decode>
  * @example
  * import { createPublicClient, http } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, getOwner } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getOwner } from '@ensdomains/ensjs/public'
  *
  * const client = createPublicClient({
  *   chain: addEnsContracts(mainnet),
@@ -241,10 +260,12 @@ type BatchableFunctionObject = GeneratedFunction<typeof encode, typeof decode>
  * const result = await getOwner(client, { name: 'ens.eth' })
  * // { owner: '0xb6E040C9ECAaE172a89bD561c5F73e1C48d28cd9', registrant: '0xb6E040C9ECAaE172a89bD561c5F73e1C48d28cd9', ownershipLevel: 'registrar }
  */
-const getOwner = generateFunction({ encode, decode }) as ((
+const getOwner = generateFunction({ encode, decode }) as (<
+  TContract extends OwnerContract | undefined = undefined,
+>(
   client: ClientWithEns,
-  { name, contract }: GetOwnerParameters,
-) => Promise<GetOwnerReturnType>) &
+  { name, contract }: GetOwnerParameters<TContract>,
+) => Promise<GetOwnerReturnType<TContract>>) &
   BatchableFunctionObject
 
 export default getOwner

package/src/functions/public/getPrice.ts

@@ -129,13 +129,14 @@ type BatchableFunctionObject = GeneratedFunction<typeof encode, typeof decode>
  * @example
  * import { createPublicClient, http } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, getPrice } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getPrice } from '@ensdomains/ensjs/public'
  *
  * const client = createPublicClient({
  *   chain: addEnsContracts(mainnet),
  *   transport: http(),
  * })
- * const result = await getPrice(client, { nameOrNames: 'ens.eth' })
+ * const result = await getPrice(client, { nameOrNames: 'ens.eth', duration: 31536000 })
  * // { base: 352828971668930335n, premium: 0n }
  */
 const getPrice = generateFunction({ encode, decode }) as ((