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

package/src/functions/wallet/clearRecords.ts

@@ -0,0 +1,97 @@
+import type {
+  Account,
+  Address,
+  Hash,
+  SendTransactionParameters,
+  Transport,
+} from 'viem'
+import type { ChainWithEns, WalletWithEns } from '../../contracts/consts.js'
+import type {
+  Prettify,
+  SimpleTransactionRequest,
+  WriteTransactionParameters,
+} from '../../types.js'
+import { encodeClearRecords } from '../../utils/encoders/encodeClearRecords.js'
+import { namehash } from '../../utils/normalise.js'
+
+export type ClearRecordsDataParameters = {
+  /** The name to clear records for */
+  name: string
+  /** The resolver address to use */
+  resolverAddress: Address
+}
+
+export type ClearRecordsDataReturnType = SimpleTransactionRequest
+
+export type ClearRecordsParameters<
+  TChain extends ChainWithEns,
+  TAccount extends Account | undefined,
+  TChainOverride extends ChainWithEns | undefined,
+> = Prettify<
+  ClearRecordsDataParameters &
+    WriteTransactionParameters<TChain, TAccount, TChainOverride>
+>
+
+export type ClearRecordsReturnType = Hash
+
+export const makeFunctionData = <
+  TChain extends ChainWithEns,
+  TAccount extends Account | undefined,
+>(
+  _wallet: WalletWithEns<Transport, TChain, TAccount>,
+  { name, resolverAddress }: ClearRecordsDataParameters,
+): ClearRecordsDataReturnType => {
+  return {
+    to: resolverAddress,
+    data: encodeClearRecords(namehash(name)),
+  }
+}
+
+/**
+ * Clears the records for a name on a resolver.
+ * @param wallet - {@link WalletWithEns}
+ * @param parameters - {@link ClearRecordsParameters}
+ * @returns Transaction hash. {@link ClearRecordsReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { clearRecords } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await clearRecords(wallet, {
+ *   name: 'ens.eth',
+ *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+ * })
+ * // 0x...
+ */
+async function clearRecords<
+  TChain extends ChainWithEns,
+  TAccount extends Account | undefined,
+  TChainOverride extends ChainWithEns | undefined = ChainWithEns,
+>(
+  wallet: WalletWithEns<Transport, TChain, TAccount>,
+  {
+    name,
+    resolverAddress,
+    ...txArgs
+  }: ClearRecordsParameters<TChain, TAccount, TChainOverride>,
+): Promise<ClearRecordsReturnType> {
+  const data = makeFunctionData(wallet, {
+    name,
+    resolverAddress,
+  })
+  const writeArgs = {
+    ...data,
+    ...txArgs,
+  } as SendTransactionParameters<TChain, TAccount, TChainOverride>
+  return wallet.sendTransaction(writeArgs)
+}
+
+clearRecords.makeFunctionData = makeFunctionData
+
+export default clearRecords

package/src/functions/wallet/commitName.ts

@@ -74,7 +74,9 @@ export const makeFunctionData = <
  * @example
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, commitName, randomSecret } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { commitName } from '@ensdomains/ensjs/wallet'
+ * import { randomSecret } from '@ensdomains/ensjs/utils'
  *
  * const wallet = createWalletClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/wallet/createSubname.ts

@@ -158,7 +158,8 @@ export const makeFunctionData = <
  * @example
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, createSubname } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { createSubname } from '@ensdomains/ensjs/wallet'
  *
  * const wallet = createWalletClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/wallet/deleteSubname.ts

@@ -148,7 +148,8 @@ export const makeFunctionData = <
  * @example
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, deleteSubname } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { deleteSubname } from '@ensdomains/ensjs/wallet'
  *
  * const wallet = createWalletClient({
  *   chain: mainnetWithEns,

package/src/functions/wallet/registerName.ts

@@ -82,7 +82,10 @@ export const makeFunctionData = <
  * @example
  * import { createPublicClient, createWalletClient, http, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, commitName, randomSecret, getPrice, registerName } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getPrice } from '@ensdomains/ensjs/public'
+ * import { randomSecret } from '@ensdomains/ensjs/utils'
+ * import { commitName, registerName } from '@ensdomains/ensjs/wallet'
  *
  * const mainnetWithEns = addEnsContracts(mainnet)
  * const client = createPublicClient({

package/src/functions/wallet/renewNames.ts

@@ -99,7 +99,9 @@ export const makeFunctionData = <
  * @example
  * import { createPublicClient, createWalletClient, http, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, renewNames, getPrice } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getPrice } from '@ensdomains/ensjs/public'
+ * import { renewNames } from '@ensdomains/ensjs/wallet'
  *
  * const mainnetWithEns = addEnsContracts(mainnet)
  * const client = createPublicClient({

package/src/functions/wallet/setAbiRecord.ts

@@ -67,7 +67,9 @@ export const makeFunctionData = <
  * import abi from './abi.json'
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, encodeAbi, setAbiRecord } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { encodeAbi } from '@ensdomains/ensjs/utils'
+ * import { setAbiRecord } from '@ensdomains/ensjs/wallet'
  *
  * const wallet = createWalletClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/wallet/setAddressRecord.ts

@@ -60,7 +60,8 @@ export const makeFunctionData = <
  * @example
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, setAddressRecord } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setAddressRecord } from '@ensdomains/ensjs/wallet'
  *
  * const wallet = createWalletClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/wallet/setChildFuses.ts

@@ -69,7 +69,8 @@ export const makeFunctionData = <
  * @example
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, setChildFuses } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setChildFuses } from '@ensdomains/ensjs/wallet'
  *
  * const wallet = createWalletClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/wallet/setContentHashRecord.ts

@@ -58,7 +58,8 @@ export const makeFunctionData = <
  * @example
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, setContentHashRecord } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setContentHashRecord } from '@ensdomains/ensjs/wallet'
  *
  * const wallet = createWalletClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/wallet/setFuses.ts

@@ -66,7 +66,8 @@ export const makeFunctionData = <
  * @example
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, setFuses } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setFuses } from '@ensdomains/ensjs/wallet'
  *
  * const wallet = createWalletClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/wallet/setPrimaryName.ts

@@ -111,7 +111,8 @@ export const makeFunctionData = <
  * @example
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, setPrimaryName } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setPrimaryName } from '@ensdomains/ensjs/wallet'
  *
  * const wallet = createWalletClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/wallet/setRecords.ts

@@ -76,7 +76,8 @@ export const makeFunctionData = <
  * @example
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, setRecords } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setRecords } from '@ensdomains/ensjs/wallet'
  *
  * const wallet = createWalletClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/wallet/setResolver.ts

@@ -86,7 +86,8 @@ export const makeFunctionData = <
  * @example
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, setResolver } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setResolver } from '@ensdomains/ensjs/wallet'
  *
  * const wallet = createWalletClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/wallet/setTextRecord.ts

@@ -60,7 +60,8 @@ export const makeFunctionData = <
  * @example
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, setTextRecord } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setTextRecord } from '@ensdomains/ensjs/wallet'
  *
  * const wallet = createWalletClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/wallet/transferName.ts

@@ -209,7 +209,8 @@ export const makeFunctionData = <
  * @example
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, transferName } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { transferName } from '@ensdomains/ensjs/wallet'
  *
  * const wallet = createWalletClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/wallet/unwrapName.ts

@@ -127,7 +127,8 @@ export const makeFunctionData = <
  * @example
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, unwrapName } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { unwrapName } from '@ensdomains/ensjs/wallet'
  *
  * const wallet = createWalletClient({
  *   chain: addEnsContracts(mainnet),

package/src/functions/wallet/wrapName.ts

@@ -141,7 +141,8 @@ export const makeFunctionData = <
  * @example
  * import { createWalletClient, custom } from 'viem'
  * import { mainnet } from 'viem/chains'
- * import { addEnsContracts, wrapName } from '@ensdomains/ensjs'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { wrapName } from '@ensdomains/ensjs/wallet'
  *
  * const wallet = createWalletClient({
  *   chain: addEnsContracts(mainnet),

package/src/subgraph.ts

@@ -63,3 +63,8 @@ export {
   type GetSubnamesParameters,
   type GetSubnamesReturnType,
 } from './functions/subgraph/getSubnames.js'
+export {
+  getChecksumAddressOrNull,
+  makeNameObject,
+  type Name,
+} from './functions/subgraph/utils.js'

package/src/utils/contentHash.ts

@@ -30,7 +30,7 @@ function matchProtocol(text: string) {
   )
 }
 
-const getDisplayCodec = (encoded: string): ProtocolType => {
+export const getDisplayCodec = (encoded: string): ProtocolType => {
   const codec = getCodec(encoded)
   switch (codec) {
     case 'ipfs':
@@ -49,7 +49,7 @@ const getDisplayCodec = (encoded: string): ProtocolType => {
   }
 }
 
-const getInternalCodec = (
+export const getInternalCodec = (
   displayCodec: NonNullable<ProtocolType>,
 ): InternalCodec => {
   switch (displayCodec) {

package/src/utils/encoders/encodeClearRecords.ts

@@ -0,0 +1,9 @@
+import { encodeFunctionData, type Hex } from 'viem'
+import { publicResolverClearRecordsSnippet } from '../../contracts/publicResolver.js'
+
+export const encodeClearRecords = (namehash: Hex) =>
+  encodeFunctionData({
+    abi: publicResolverClearRecordsSnippet,
+    functionName: 'clearRecords',
+    args: [namehash],
+  })

package/src/utils/fuses.ts

@@ -114,7 +114,7 @@ type GenericFuseEnum<TGroupName extends FuseRestriction = FuseRestriction> = {
   Maximum: bigint
 }
 
-const ChildReference = {
+export const ChildFuseReference = {
   Name: 'child',
   Object: ChildFuses,
   Keys: ChildFuseKeys,
@@ -124,12 +124,12 @@ const ChildReference = {
   Minimum: 0n,
   Maximum: 2n ** 16n - 1n,
 } as const
-type ChildReference = typeof ChildReference & {
-  Key: keyof ChildReference['Object']
-  UnnamedKey: ChildReference['Unnamed'][number]
+export type ChildFuseReferenceType = typeof ChildFuseReference & {
+  Key: keyof ChildFuseReferenceType['Object']
+  UnnamedKey: ChildFuseReferenceType['Unnamed'][number]
 }
 
-const ParentReference = {
+export const ParentFuseReference = {
   Name: 'parent',
   Object: ParentFuses,
   Keys: ParentFuseKeys,
@@ -139,12 +139,12 @@ const ParentReference = {
   Minimum: 2n ** 16n,
   Maximum: 2n ** 32n,
 } as const
-type ParentReference = typeof ParentReference & {
-  Key: keyof ParentReference['Object']
-  UnnamedKey: ParentReference['Unnamed'][number]
+export type ParentFuseReferenceType = typeof ParentFuseReference & {
+  Key: keyof ParentFuseReferenceType['Object']
+  UnnamedKey: ParentFuseReferenceType['Unnamed'][number]
 }
 
-const FullParentReference = {
+export const FullParentFuseReference = {
   Name: 'parent',
   Object: FullParentFuses,
   Keys: FullParentFuseKeys,
@@ -154,9 +154,9 @@ const FullParentReference = {
   Minimum: 2n ** 16n,
   Maximum: 2n ** 32n,
 } as const
-type FullParentReference = typeof FullParentReference & {
-  Key: keyof FullParentReference['Object']
-  UnnamedKey: ParentReference['Unnamed'][number]
+export type FullParentFuseReferenceType = typeof FullParentFuseReference & {
+  Key: keyof FullParentFuseReferenceType['Object']
+  UnnamedKey: ParentFuseReferenceType['Unnamed'][number]
 }
 
 type InputFuses<NamedFuse extends string, UnnamedFuse extends bigint> =
@@ -177,12 +177,12 @@ type InputFuses<NamedFuse extends string, UnnamedFuse extends bigint> =
     }
 
 export type EncodeChildFusesInputObject = InputFuses<
-  ChildReference['Key'],
-  ChildReference['UnnamedKey']
+  ChildFuseReferenceType['Key'],
+  ChildFuseReferenceType['UnnamedKey']
 >
 export type EncodeParentFusesInputObject = InputFuses<
-  ParentReference['Key'],
-  ParentReference['UnnamedKey']
+  ParentFuseReferenceType['Key'],
+  ParentFuseReferenceType['UnnamedKey']
 >
 
 export type EncodeFusesInputObject =
@@ -293,7 +293,8 @@ export const encodeFuses = ({
       })
     return checkFuseObject({
       object: input,
-      reference: restriction === 'child' ? ChildReference : ParentReference,
+      reference:
+        restriction === 'child' ? ChildFuseReference : ParentFuseReference,
     })
   }
 
@@ -310,11 +311,14 @@ export const encodeFuses = ({
 
   const childFuses =
     'child' in input
-      ? checkFuseObject({ object: input.child, reference: ChildReference })
+      ? checkFuseObject({ object: input.child, reference: ChildFuseReference })
       : 0
   const parentFuses =
     'parent' in input
-      ? checkFuseObject({ object: input.parent, reference: ParentReference })
+      ? checkFuseObject({
+          object: input.parent,
+          reference: ParentFuseReference,
+        })
       : 0
 
   return Number(childFuses | parentFuses)
@@ -328,10 +332,10 @@ type DecodedFuseGroup<TFuseReference extends GenericFuseEnum> = {
   }
 }
 
-type DecodedChildFuses = DecodedFuseGroup<ChildReference> & {
+type DecodedChildFuses = DecodedFuseGroup<ChildFuseReferenceType> & {
   CAN_DO_EVERYTHING: boolean
 }
-type DecodedParentFuses = DecodedFuseGroup<FullParentReference>
+type DecodedParentFuses = DecodedFuseGroup<FullParentFuseReferenceType>
 
 export type DecodedFuses = {
   child: DecodedChildFuses
@@ -364,12 +368,12 @@ export const decodeFuses = (fuses: number): DecodedFuses => {
   return {
     parent: decodeFusesFromReference({
       input: fusesBigInt,
-      reference: FullParentReference,
+      reference: FullParentFuseReference,
     }),
     child: {
       ...decodeFusesFromReference({
         input: fusesBigInt,
-        reference: ChildReference,
+        reference: ChildFuseReference,
       }),
       CAN_DO_EVERYTHING:
         (fusesBigInt & FuseRanges.CHILD_CONTROLLED_FUSES) === 0n,

package/src/utils/generateRecordCallArray.ts

@@ -1,6 +1,6 @@
-import { encodeFunctionData, type Hex } from 'viem'
-import { publicResolverClearRecordsSnippet } from '../contracts/publicResolver.js'
+import { type Hex } from 'viem'
 import type { Prettify } from '../types.js'
+import { encodeClearRecords } from './encoders/encodeClearRecords.js'
 import {
   encodeSetAbi,
   type EncodeSetAbiParameters,
@@ -39,13 +39,7 @@ export const generateRecordCallArray = ({
   const calls: Hex[] = []
 
   if (clearRecords) {
-    calls.push(
-      encodeFunctionData({
-        abi: publicResolverClearRecordsSnippet,
-        functionName: 'clearRecords',
-        args: [namehash],
-      }),
-    )
+    calls.push(encodeClearRecords(namehash))
   }
 
   if (typeof contentHash === 'string') {

package/src/utils/index.ts

@@ -6,6 +6,7 @@ export {
   type EncodeAbiReturnType,
   type EncodedAbi,
 } from './encoders/encodeAbi.js'
+export { encodeClearRecords } from './encoders/encodeClearRecords.js'
 export {
   encodeSetAbi,
   type EncodeSetAbiParameters,
@@ -36,11 +37,14 @@ export {
 } from './consts.js'
 export {
   ChildFuseKeys,
+  ChildFuseReference,
   ChildFuses,
   FullParentFuseKeys,
+  FullParentFuseReference,
   FullParentFuses,
   FuseRanges,
   ParentFuseKeys,
+  ParentFuseReference,
   ParentFuses,
   UnnamedChildFuseKeys,
   UnnamedChildFuses,
@@ -51,15 +55,20 @@ export {
   checkPccBurned,
   decodeFuses,
   encodeFuses,
+  type ChildFuseReferenceType,
   type DecodedFuses,
   type EncodeChildFusesInputObject,
   type EncodeFusesInputObject,
   type EncodeParentFusesInputObject,
+  type FullParentFuseReferenceType,
+  type ParentFuseReferenceType,
 } from './fuses.js'
 
 export {
   decodeContentHash,
   encodeContentHash,
+  getDisplayCodec,
+  getInternalCodec,
   getProtocolType,
   isValidContentHash,
   type DecodedContentHash,

package/src/utils/normaliseCoinId.ts

@@ -0,0 +1,11 @@
+export const normaliseCoinId = (coinId: string | number) => {
+  const isString = typeof coinId === 'string'
+
+  if (isString && Number.isNaN(parseInt(coinId))) {
+    return { type: 'name', value: coinId.toUpperCase() } as const
+  }
+  return {
+    type: 'id',
+    value: isString ? parseInt(coinId as string) : (coinId as number),
+  } as const
+}

package/src/wallet.ts

@@ -1,3 +1,10 @@
+export {
+  default as clearRecords,
+  type ClearRecordsDataParameters,
+  type ClearRecordsDataReturnType,
+  type ClearRecordsParameters,
+  type ClearRecordsReturnType,
+} from './functions/wallet/clearRecords.js'
 export {
   default as commitName,
   type CommitNameDataParameters,