@ensdomains/ensjs 4.1.1 → 5.0.0-alpha.0

package/src/actions/wallet/deleteSubname.ts

@@ -0,0 +1,241 @@
+import {
+  type Account,
+  type Chain,
+  type GetChainContractAddressErrorType,
+  type Hash,
+  type NamehashErrorType,
+  namehash,
+  type WriteContractErrorType,
+  type WriteContractParameters,
+  zeroAddress,
+} from 'viem'
+import { writeContract } from 'viem/actions'
+import { getAction } from 'viem/utils'
+import {
+  type ChainWithContracts,
+  getChainContractAddress,
+  type RequireClientContracts,
+} from '../../clients/chain.js'
+import {
+  nameWrapperSetRecordSnippet,
+  nameWrapperSetSubnodeRecordSnippet,
+} from '../../contracts/nameWrapper.js'
+import {
+  registrySetRecordSnippet,
+  registrySetSubnodeRecordSnippet,
+} from '../../contracts/registry.js'
+import {
+  InvalidContractTypeError,
+  UnsupportedNameTypeError,
+} from '../../errors/general.js'
+import type { Prettify, WriteTransactionParameters } from '../../types/index.js'
+import { ASSERT_NO_TYPE_ERROR } from '../../types/internal.js'
+import {
+  type ClientWithOverridesErrorType,
+  clientWithOverrides,
+} from '../../utils/clientWithOverrides.js'
+import { getNameType } from '../../utils/name/getNameType.js'
+import {
+  type MakeLabelNodeAndParentErrorType,
+  makeLabelNodeAndParent,
+} from '../../utils/name/makeLabelNodeAndParent.js'
+
+// ================================
+// Write parameters
+// ================================
+
+export type DeleteSubnameWriteParametersParameters = {
+  /** Subname to delete */
+  name: string
+  /** Contract to delete subname on */
+  contract: 'registry' | 'nameWrapper'
+  /** If true, deletes via owner methods, otherwise will delete via parent owner methods */
+  asOwner?: boolean
+}
+
+export type DeleteSubnameWriteParametersReturnType = ReturnType<
+  typeof deleteSubnameWriteParameters
+>
+
+export type DeleteSubnameWriteParametersErrorType =
+  | UnsupportedNameTypeError
+  | GetChainContractAddressErrorType
+  | NamehashErrorType
+  | MakeLabelNodeAndParentErrorType
+  | InvalidContractTypeError
+
+export const deleteSubnameWriteParameters = <
+  chain extends Chain,
+  account extends Account,
+>(
+  client: RequireClientContracts<
+    chain,
+    'ensRegistry' | 'ensNameWrapper',
+    account
+  >,
+  { name, contract, asOwner }: DeleteSubnameWriteParametersParameters,
+) => {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const nameType = getNameType(name)
+  if (nameType !== 'eth-subname' && nameType !== 'other-subname')
+    throw new UnsupportedNameTypeError({
+      nameType,
+      supportedNameTypes: ['eth-subname', 'other-subname'],
+      details: 'Cannot delete a name that is not a subname',
+    })
+
+  switch (contract) {
+    case 'registry': {
+      const baseParams = {
+        address: getChainContractAddress({
+          chain: client.chain,
+          contract: 'ensRegistry',
+        }),
+        chain: client.chain,
+        account: client.account,
+      } as const
+      if (asOwner)
+        return {
+          ...baseParams,
+          abi: registrySetRecordSnippet,
+          functionName: 'setRecord',
+          args: [namehash(name), zeroAddress, zeroAddress, BigInt(0)],
+        } as const satisfies WriteContractParameters<
+          typeof registrySetRecordSnippet
+        >
+
+      const { labelhash, parentNode } = makeLabelNodeAndParent(name)
+      return {
+        ...baseParams,
+        abi: registrySetSubnodeRecordSnippet,
+        functionName: 'setSubnodeRecord',
+        args: [parentNode, labelhash, zeroAddress, zeroAddress, BigInt(0)],
+      } as const satisfies WriteContractParameters<
+        typeof registrySetSubnodeRecordSnippet
+      >
+    }
+    case 'nameWrapper': {
+      const baseParams = {
+        address: getChainContractAddress({
+          chain: client.chain,
+          contract: 'ensNameWrapper',
+        }),
+        chain: client.chain,
+        account: client.account,
+      } as const
+      if (asOwner)
+        return {
+          ...baseParams,
+          abi: nameWrapperSetRecordSnippet,
+          functionName: 'setRecord',
+          args: [namehash(name), zeroAddress, zeroAddress, BigInt(0)],
+        } as const satisfies WriteContractParameters<
+          typeof nameWrapperSetRecordSnippet
+        >
+
+      const { label, parentNode } = makeLabelNodeAndParent(name)
+      return {
+        ...baseParams,
+        abi: nameWrapperSetSubnodeRecordSnippet,
+        functionName: 'setSubnodeRecord',
+        args: [
+          parentNode,
+          label,
+          zeroAddress,
+          zeroAddress,
+          BigInt(0),
+          0,
+          BigInt(0),
+        ],
+      } as const satisfies WriteContractParameters<
+        typeof nameWrapperSetSubnodeRecordSnippet
+      >
+    }
+    default:
+      throw new InvalidContractTypeError({
+        contractType: contract,
+        supportedContractTypes: ['registry', 'nameWrapper'],
+      })
+  }
+}
+
+// ================================
+// Delete subname action
+// ================================
+
+export type DeleteSubnameParameters<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends
+    | ChainWithContracts<'ensRegistry' | 'ensNameWrapper'>
+    | undefined,
+> = Prettify<
+  DeleteSubnameWriteParametersParameters &
+    WriteTransactionParameters<chain, account, chainOverride>
+>
+
+export type DeleteSubnameReturnType = Hash
+
+export type DeleteSubnameErrorType =
+  | DeleteSubnameWriteParametersErrorType
+  | ClientWithOverridesErrorType
+  | WriteContractErrorType
+
+/**
+ * Deletes a subname
+ * @param client - {@link Client}
+ * @param options - {@link DeleteSubnameOptions}
+ * @returns Transaction hash. {@link DeleteSubnameReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { deleteSubname } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: mainnetWithEns,
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await deleteSubname(wallet, {
+ *   name: 'sub.ens.eth',
+ *   contract: 'registry',
+ * })
+ * // 0x...
+ */
+export async function deleteSubname<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends
+    | ChainWithContracts<'ensRegistry' | 'ensNameWrapper'>
+    | undefined,
+>(
+  client: RequireClientContracts<
+    chain,
+    'ensRegistry' | 'ensNameWrapper',
+    account
+  >,
+  {
+    name,
+    contract,
+    asOwner,
+    ...txArgs
+  }: DeleteSubnameParameters<chain, account, chainOverride>,
+): Promise<DeleteSubnameReturnType> {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const data = deleteSubnameWriteParameters(
+    clientWithOverrides(client, txArgs),
+    {
+      name,
+      contract,
+      asOwner,
+    },
+  )
+  const writeContractAction = getAction(client, writeContract, 'writeContract')
+  return writeContractAction({
+    ...data,
+    ...txArgs,
+  } as WriteContractParameters)
+}

package/src/actions/wallet/registerName.ts

@@ -0,0 +1,190 @@
+import type {
+  Account,
+  Chain,
+  GetChainContractAddressErrorType,
+  Hash,
+  WriteContractErrorType,
+  WriteContractParameters,
+} from 'viem'
+import { writeContract } from 'viem/actions'
+import { getAction } from 'viem/utils'
+import {
+  type ChainWithContracts,
+  getChainContractAddress,
+  type RequireClientContracts,
+} from '../../clients/chain.js'
+import { l2EthRegistrarRegisterSnippet } from '../../contracts/l2EthRegistrar.js'
+import { UnsupportedNameTypeError } from '../../errors/general.js'
+import type { Prettify, WriteTransactionParameters } from '../../types/index.js'
+import { ASSERT_NO_TYPE_ERROR } from '../../types/internal.js'
+import {
+  type ClientWithOverridesErrorType,
+  clientWithOverrides,
+} from '../../utils/clientWithOverrides.js'
+import {
+  type L2RegistrationParameters,
+  type MakeL2CommitmentTupleErrorType,
+  makeL2CommitmentTuple,
+} from '../../utils/l2RegisterHelpers.js'
+import { getNameType } from '../../utils/name/getNameType.js'
+import {
+  type WrappedLabelLengthCheckErrorType,
+  wrappedLabelLengthCheck,
+} from '../../utils/wrapper.js'
+
+// ================================
+// Write parameters
+// ================================
+
+export type RegisterNameWriteParametersParameters = L2RegistrationParameters & {
+  /** Value of registration */
+  value: bigint
+}
+
+export type RegisterNameWriteParametersReturnType<
+  chain extends Chain,
+  account extends Account,
+> = ReturnType<typeof registerNameWriteParameters<chain, account>>
+
+export type RegisterNameWriteParametersErrorType =
+  | UnsupportedNameTypeError
+  | WrappedLabelLengthCheckErrorType
+  | GetChainContractAddressErrorType
+  | MakeL2CommitmentTupleErrorType
+
+export const registerNameWriteParameters = <
+  chain extends Chain,
+  account extends Account,
+>(
+  client: RequireClientContracts<chain, 'ensL2EthRegistrar', account>,
+  { value, ...registrationParams }: RegisterNameWriteParametersParameters,
+) => {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const nameType = getNameType(registrationParams.name)
+  if (nameType !== 'eth-2ld')
+    throw new UnsupportedNameTypeError({
+      nameType,
+      supportedNameTypes: ['eth-2ld'],
+      details: 'Only 2ld-eth name registration is supported',
+    })
+
+  const labels = registrationParams.name.split('.')
+  wrappedLabelLengthCheck(labels[0])
+
+  // Use the commitment tuple helper for consistency
+  const commitmentTuple = makeL2CommitmentTuple(registrationParams)
+
+  return {
+    address: getChainContractAddress({
+      chain: client.chain,
+      contract: 'ensL2EthRegistrar',
+    }),
+    abi: l2EthRegistrarRegisterSnippet,
+    functionName: 'register',
+    args: commitmentTuple,
+    chain: client.chain,
+    account: client.account,
+    value,
+  } as const satisfies WriteContractParameters<
+    typeof l2EthRegistrarRegisterSnippet
+  >
+}
+
+// ================================
+// Register name action
+// ================================
+
+export type RegisterNameParameters<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends ChainWithContracts<'ensL2EthRegistrar'> | undefined,
+> = Prettify<
+  RegisterNameWriteParametersParameters &
+    WriteTransactionParameters<chain, account, chainOverride>
+>
+
+export type RegisterNameReturnType = Hash
+
+export type RegisterNameErrorType =
+  | RegisterNameWriteParametersErrorType
+  | ClientWithOverridesErrorType
+  | WriteContractErrorType
+
+/**
+ * Registers a name on ENS
+ * @param client - {@link Client}
+ * @param options - {@link RegisterNameOptions}
+ * @returns Transaction hash. {@link RegisterNameReturnType}
+ *
+ * @example
+ * import { createPublicClient, createWalletClient, http, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * 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 publicClient = createPublicClient({
+ *   chain: mainnetWithEns,
+ *   transport: http(),
+ * })
+ * const wallet = createWalletClient({
+ *   chain: mainnetWithEns,
+ *   transport: custom(window.ethereum),
+ * })
+ * const secret = randomSecret()
+ * const params = {
+ *   name: 'example.eth',
+ *   owner: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ *   duration: 31536000, // 1 year
+ *   secret,
+ * }
+ *
+ * const commitmentHash = await commitName(wallet, params)
+ * await publicClient.waitForTransactionReceipt({ hash: commitmentHash }) // wait for commitment to finalise
+ * await new Promise((resolve) => setTimeout(resolve, 60 * 1_000)) // wait for commitment to be valid
+ *
+ * const { base, premium } = await getPrice(publicClient, { nameOrNames: params.name, duration: params.duration })
+ * const value = (base + premium) * 110n / 100n // add 10% to the price for buffer
+ * const hash = await registerName(wallet, { ...params, value })
+ * // 0x...
+ */
+export async function registerName<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends ChainWithContracts<'ensL2EthRegistrar'> | undefined,
+>(
+  client: RequireClientContracts<chain, 'ensL2EthRegistrar', account>,
+  {
+    name,
+    owner,
+    duration,
+    secret,
+    resolverAddress,
+    subregistryAddress,
+    value,
+    ...txArgs
+  }: RegisterNameParameters<chain, account, chainOverride>,
+): Promise<RegisterNameReturnType> {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const writeParameters = registerNameWriteParameters(
+    clientWithOverrides(client, txArgs),
+    {
+      name,
+      owner,
+      duration,
+      secret,
+      resolverAddress,
+      subregistryAddress,
+      value,
+    },
+  )
+  const writeContractAction = getAction(client, writeContract, 'writeContract')
+  return writeContractAction({
+    ...writeParameters,
+    ...txArgs,
+  } as WriteContractParameters)
+}

package/src/actions/wallet/renewNames.ts

@@ -0,0 +1,167 @@
+import type {
+  Account,
+  Chain,
+  GetChainContractAddressErrorType,
+  WriteContractErrorType,
+  WriteContractParameters,
+  WriteContractReturnType,
+} from 'viem'
+import { writeContract } from 'viem/actions'
+import { getAction } from 'viem/utils'
+import {
+  type ChainWithContracts,
+  getChainContractAddress,
+  type RequireClientContracts,
+} from '../../clients/chain.js'
+import { l2EthRegistrarRenewSnippet } from '../../contracts/l2EthRegistrar.js'
+import { UnsupportedNameTypeError } from '../../errors/general.js'
+import type { Prettify, WriteTransactionParameters } from '../../types/index.js'
+import { ASSERT_NO_TYPE_ERROR } from '../../types/internal.js'
+import {
+  type ClientWithOverridesErrorType,
+  clientWithOverrides,
+} from '../../utils/clientWithOverrides.js'
+import { getNameType } from '../../utils/name/getNameType.js'
+
+// ================================
+// Write parameters
+// ================================
+
+export type RenewNamesWriteParametersParameters = {
+  /** Name to renew */
+  nameOrNames: string | string[]
+  /** Duration to renew name for */
+  duration: bigint | number
+  /** Value of renewal */
+  value: bigint
+}
+
+export type RenewNamesWriteParametersReturnType = ReturnType<
+  typeof renewNamesWriteParameters
+>
+
+export type RenewNamesWriteParametersErrorType =
+  | UnsupportedNameTypeError
+  | GetChainContractAddressErrorType
+
+export const renewNamesWriteParameters = <
+  chain extends Chain,
+  account extends Account,
+>(
+  client: RequireClientContracts<chain, 'ensEthRegistrarController', account>,
+  { nameOrNames, duration, value }: RenewNamesWriteParametersParameters,
+) => {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  if (Array.isArray(nameOrNames)) {
+    throw new Error('Array of names is not currently supported for renewals')
+  }
+
+  const name = nameOrNames
+  const label = name.split('.')
+  const nameType = getNameType(name)
+  if (nameType !== 'eth-2ld')
+    throw new UnsupportedNameTypeError({
+      nameType,
+      supportedNameTypes: ['eth-2ld'],
+      details: 'Only 2ld-eth renewals are currently supported',
+    })
+
+  const baseParams = {
+    chain: client.chain,
+    account: client.account,
+    value,
+  } as const
+
+  return {
+    ...baseParams,
+    address: getChainContractAddress({
+      chain: client.chain,
+      contract: 'ensEthRegistrarController',
+    }),
+    abi: l2EthRegistrarRenewSnippet,
+    functionName: 'renew',
+    args: [label[0], BigInt(duration)],
+  } as const satisfies WriteContractParameters
+}
+
+// ================================
+// Renew names action
+// ================================
+
+export type RenewNamesParameters<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends
+    | ChainWithContracts<'ensEthRegistrarController'>
+    | undefined,
+> = Prettify<
+  RenewNamesWriteParametersParameters &
+    WriteTransactionParameters<chain, account, chainOverride>
+>
+
+export type RenewNamesReturnType = WriteContractReturnType
+
+export type RenewNamesErrorType =
+  | RenewNamesWriteParametersErrorType
+  | ClientWithOverridesErrorType
+  | WriteContractErrorType
+
+/**
+ * Renews a name or names for a specified duration.
+ * @param client - {@link Client}
+ * @param options - {@link RenewNamesOptions}
+ * @returns Transaction hash. {@link RenewNamesReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { getPrice } from '@ensdomains/ensjs/public'
+ * import { renewNames } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ *
+ * const duration = 31536000n // 1 year
+ * const { base, premium } = await getPrice(wallet, {
+ *  nameOrNames: 'example.eth',
+ *  duration,
+ * })
+ * const value = (base + premium) * 110n / 100n // add 10% to the price for buffer
+ * const hash = await renewNames(wallet, {
+ *   nameOrNames: 'example.eth',
+ *   duration,
+ *   value,
+ * })
+ * // 0x...
+ */
+export async function renewNames<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends
+    | ChainWithContracts<'ensEthRegistrarController'>
+    | undefined,
+>(
+  client: RequireClientContracts<chain, 'ensEthRegistrarController', account>,
+  {
+    nameOrNames,
+    duration,
+    value,
+    ...txArgs
+  }: RenewNamesParameters<chain, account, chainOverride>,
+): Promise<RenewNamesReturnType> {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const writeParameters = renewNamesWriteParameters(
+    clientWithOverrides(client, txArgs),
+    { nameOrNames, duration, value },
+  )
+  const writeContractAction = getAction(client, writeContract, 'writeContract')
+  return writeContractAction({
+    ...writeParameters,
+    ...txArgs,
+  } as WriteContractParameters)
+}