@ensdomains/ensjs 4.1.2 → 5.0.0-alpha.0

package/src/actions/wallet/setTextRecord.ts

@@ -0,0 +1,137 @@
+import type {
+  Account,
+  Address,
+  Chain,
+  Client,
+  Transport,
+  WriteContractErrorType,
+  WriteContractParameters,
+  WriteContractReturnType,
+} from 'viem'
+import { type NamehashErrorType, namehash } from 'viem'
+import { writeContract } from 'viem/actions'
+import { getAction } from 'viem/utils'
+import type { Prettify, WriteTransactionParameters } from '../../types/index.js'
+import {
+  type ClientWithOverridesErrorType,
+  clientWithOverrides,
+} from '../../utils/clientWithOverrides.js'
+import {
+  type SetTextParametersErrorType,
+  type SetTextParametersReturnType,
+  setTextParameters,
+} from '../../utils/coders/setText.js'
+
+export type SetTextRecordWriteParametersParameters = {
+  /** The name to set a text record for */
+  name?: string
+  /** The text record key to set */
+  key: string
+  /** The text record value to set */
+  value: string | null
+  /** The resolver address to use */
+  resolverAddress: Address
+}
+
+export type SetTextRecordWriteParametersReturnType = ReturnType<
+  typeof setTextRecordWriteParameters
+>
+
+export type SetTextRecordWriteParametersErrorType =
+  | SetTextParametersErrorType
+  | NamehashErrorType
+
+export const setTextRecordWriteParameters = <
+  chain extends Chain,
+  account extends Account,
+>(
+  client: Client<Transport, chain, account>,
+  { name, key, value, resolverAddress }: SetTextRecordWriteParametersParameters,
+) => {
+  return {
+    address: resolverAddress,
+    chain: client.chain,
+    account: client.account,
+    ...setTextParameters(
+      typeof name === 'string'
+        ? { namehash: namehash(name), key, value }
+        : { key, value },
+    ),
+  } as const satisfies WriteContractParameters<
+    SetTextParametersReturnType['abi']
+  >
+}
+
+// ================================
+// Action
+// ================================
+
+export type SetTextRecordParameters<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends Chain,
+> = Prettify<
+  SetTextRecordWriteParametersParameters &
+    WriteTransactionParameters<chain, account, chainOverride>
+>
+
+export type SetTextRecordReturnType = WriteContractReturnType
+
+export type SetTextRecordErrorType =
+  | SetTextRecordWriteParametersErrorType
+  | ClientWithOverridesErrorType
+  | WriteContractErrorType
+
+/**
+ * Sets a text record for a name on a resolver.
+ * @param client - {@link Client}
+ * @param options - {@link SetTextRecordOptions}
+ * @returns Transaction hash. {@link SetTextRecordReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { setTextRecord } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await setTextRecord(wallet, {
+ *   name: 'ens.eth',
+ *   key: 'foo',
+ *   value: 'bar',
+ *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
+ * })
+ * // 0x...
+ */
+export async function setTextRecord<
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends Chain,
+>(
+  client: Client<Transport, chain, account>,
+  {
+    name,
+    key,
+    value,
+    resolverAddress,
+    ...txArgs
+  }: SetTextRecordParameters<chain, account, chainOverride>,
+): Promise<SetTextRecordReturnType> {
+  const writeParameters = setTextRecordWriteParameters(
+    clientWithOverrides(client, txArgs),
+    {
+      name,
+      key,
+      value,
+      resolverAddress,
+    },
+  )
+  const writeContractAction = getAction(client, writeContract, 'writeContract')
+  return writeContractAction({
+    ...writeParameters,
+    ...txArgs,
+  } as WriteContractParameters)
+}

package/src/actions/wallet/transferName.ts

@@ -0,0 +1,314 @@
+import {
+  type Account,
+  type Address,
+  type Chain,
+  type GetChainContractAddressErrorType,
+  type LabelhashErrorType,
+  labelhash,
+  type NamehashErrorType,
+  namehash,
+  type WriteContractErrorType,
+  type WriteContractParameters,
+  type WriteContractReturnType,
+} from 'viem'
+import { writeContract } from 'viem/actions'
+import { getAction } from 'viem/utils'
+import {
+  type ChainWithContracts,
+  getChainContractAddress,
+  type RequireClientContracts,
+} from '../../clients/chain.js'
+import {
+  baseRegistrarReclaimSnippet,
+  baseRegistrarSafeTransferFromSnippet,
+} from '../../contracts/baseRegistrar.js'
+import {
+  nameWrapperSafeTransferFromSnippet,
+  nameWrapperSetSubnodeOwnerSnippet,
+} from '../../contracts/nameWrapper.js'
+import {
+  registrySetOwnerSnippet,
+  registrySetSubnodeOwnerSnippet,
+} from '../../contracts/registry.js'
+import {
+  AdditionalParameterSpecifiedError,
+  InvalidContractTypeError,
+  UnsupportedNameTypeError,
+} from '../../errors/general.js'
+import type { ErrorType } from '../../errors/utils.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'
+
+export type TransferNameSupportedContract =
+  | 'registry'
+  | 'nameWrapper'
+  | 'registrar'
+
+export type TransferNameWriteParametersParameters<
+  contract extends TransferNameSupportedContract,
+> = {
+  /** Name to transfer */
+  name: string
+  /** Transfer recipient */
+  newOwnerAddress: Address
+  /** Contract to use for transfer */
+  contract: contract
+  /** Reclaim ownership as registrant (registrar only) */
+  reclaim?: contract extends 'registrar' ? boolean : never
+  /** Transfer name as the parent owner */
+  asParent?: contract extends 'registrar' ? never : boolean
+}
+
+export type TransferNameWriteParametersErrorType =
+  | AdditionalParameterSpecifiedError
+  | GetChainContractAddressErrorType
+  | MakeLabelNodeAndParentErrorType
+  | NamehashErrorType
+  | LabelhashErrorType
+  | InvalidContractTypeError
+  | UnsupportedNameTypeError
+  | ErrorType
+
+export const transferNameWriteParameters = <
+  contract extends TransferNameSupportedContract,
+  chain extends Chain,
+  account extends Account,
+>(
+  client: RequireClientContracts<
+    chain,
+    'ensRegistry' | 'ensNameWrapper' | 'ensBaseRegistrarImplementation',
+    account
+  >,
+  {
+    name,
+    newOwnerAddress,
+    contract,
+    reclaim,
+    asParent,
+  }: TransferNameWriteParametersParameters<contract>,
+) => {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  if (reclaim && contract !== 'registrar')
+    throw new AdditionalParameterSpecifiedError({
+      parameter: 'reclaim',
+      allowedParameters: ['name', 'newOwnerAddress', 'contract'],
+      details:
+        "Can't reclaim a name from any contract other than the registrar",
+    })
+  switch (contract) {
+    case 'registry': {
+      const baseParams = {
+        address: getChainContractAddress({
+          chain: client.chain,
+          contract: 'ensRegistry',
+        }),
+        chain: client.chain,
+        account: client.account,
+      } as const
+      if (asParent) {
+        const { labelhash: labelhashId, parentNode } =
+          makeLabelNodeAndParent(name)
+        return {
+          ...baseParams,
+          abi: registrySetSubnodeOwnerSnippet,
+          functionName: 'setSubnodeOwner',
+          args: [parentNode, labelhashId, newOwnerAddress],
+        } as const satisfies WriteContractParameters<
+          typeof registrySetSubnodeOwnerSnippet
+        >
+      }
+
+      return {
+        ...baseParams,
+        abi: registrySetOwnerSnippet,
+        functionName: 'setOwner',
+        args: [namehash(name), newOwnerAddress],
+      } as const satisfies WriteContractParameters<
+        typeof registrySetOwnerSnippet
+      >
+    }
+    case 'registrar': {
+      if (asParent)
+        throw new AdditionalParameterSpecifiedError({
+          parameter: 'asParent',
+          allowedParameters: ['name', 'newOwnerAddress', 'contract', 'reclaim'],
+          details: "Can't transfer a name as the parent owner on the registrar",
+        })
+      const nameType = getNameType(name)
+      if (nameType !== 'eth-2ld')
+        throw new UnsupportedNameTypeError({
+          nameType,
+          supportedNameTypes: ['eth-2ld'],
+          details:
+            'Only eth-2ld names can be transferred on the registrar contract',
+        })
+      const labels = name.split('.')
+      const tokenId = BigInt(labelhash(labels[0]))
+      const baseParams = {
+        address: getChainContractAddress({
+          chain: client.chain,
+          contract: 'ensBaseRegistrarImplementation',
+        }),
+        chain: client.chain,
+        account: client.account,
+      }
+      if (reclaim)
+        return {
+          ...baseParams,
+          abi: baseRegistrarReclaimSnippet,
+          functionName: 'reclaim',
+          args: [tokenId, newOwnerAddress],
+        } as const satisfies WriteContractParameters<
+          typeof baseRegistrarReclaimSnippet
+        >
+
+      return {
+        ...baseParams,
+        abi: baseRegistrarSafeTransferFromSnippet,
+        functionName: 'safeTransferFrom',
+        args: [client.account.address, newOwnerAddress, tokenId],
+      } as const satisfies WriteContractParameters<
+        typeof baseRegistrarSafeTransferFromSnippet
+      >
+    }
+    case 'nameWrapper': {
+      const baseParams = {
+        address: getChainContractAddress({
+          chain: client.chain,
+          contract: 'ensNameWrapper',
+        }),
+        chain: client.chain,
+        account: client.account,
+      } as const
+      if (asParent) {
+        const { label, parentNode } = makeLabelNodeAndParent(name)
+        return {
+          ...baseParams,
+          abi: nameWrapperSetSubnodeOwnerSnippet,
+          functionName: 'setSubnodeOwner',
+          args: [parentNode, label, newOwnerAddress, 0, BigInt(0)],
+        } as const satisfies WriteContractParameters<
+          typeof nameWrapperSetSubnodeOwnerSnippet
+        >
+      }
+
+      return {
+        ...baseParams,
+        abi: nameWrapperSafeTransferFromSnippet,
+        functionName: 'safeTransferFrom',
+        args: [
+          client.account.address,
+          newOwnerAddress,
+          BigInt(namehash(name)),
+          BigInt(1),
+          '0x',
+        ],
+      } as const satisfies WriteContractParameters<
+        typeof nameWrapperSafeTransferFromSnippet
+      >
+    }
+    default:
+      throw new InvalidContractTypeError({
+        contractType: contract,
+        supportedContractTypes: ['registry', 'registrar', 'nameWrapper'],
+      })
+  }
+}
+
+// ================================
+// Action
+// ================================
+
+export type TransferNameParameters<
+  contract extends 'registry' | 'nameWrapper' | 'registrar',
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends ChainWithContracts<
+    'ensRegistry' | 'ensNameWrapper' | 'ensBaseRegistrarImplementation'
+  >,
+> = Prettify<
+  TransferNameWriteParametersParameters<contract> &
+    WriteTransactionParameters<chain, account, chainOverride>
+>
+
+export type TransferNameReturnType = WriteContractReturnType
+
+export type TransferNameErrorType =
+  | TransferNameWriteParametersErrorType
+  | ClientWithOverridesErrorType
+  | WriteContractErrorType
+
+/**
+ * Transfers a name to a new owner.
+ * @param client - {@link Client}
+ * @param options - {@link TransferNameOptions}
+ * @returns Transaction hash. {@link TransferNameReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { transferName } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await transferName(wallet, {
+ *   name: 'ens.eth',
+ *   newOwnerAddress: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ *   contract: 'registry',
+ * })
+ * // 0x...
+ */
+export async function transferName<
+  contract extends TransferNameSupportedContract,
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends ChainWithContracts<
+    'ensRegistry' | 'ensNameWrapper' | 'ensBaseRegistrarImplementation'
+  >,
+>(
+  client: RequireClientContracts<
+    chain,
+    'ensRegistry' | 'ensNameWrapper' | 'ensBaseRegistrarImplementation',
+    account
+  >,
+  {
+    name,
+    newOwnerAddress,
+    contract,
+    reclaim,
+    asParent,
+    ...txArgs
+  }: TransferNameParameters<contract, chain, account, chainOverride>,
+): Promise<TransferNameReturnType> {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const writeParameters = transferNameWriteParameters(
+    clientWithOverrides(client, txArgs),
+    {
+      name,
+      newOwnerAddress,
+      contract,
+      reclaim,
+      asParent,
+    } as TransferNameWriteParametersParameters<contract>,
+  )
+
+  const writeContractAction = getAction(client, writeContract, 'writeContract')
+  return writeContractAction({
+    ...writeParameters,
+    ...txArgs,
+  } as WriteContractParameters)
+}

package/src/actions/wallet/unwrapName.ts

@@ -0,0 +1,194 @@
+import type {
+  Account,
+  Address,
+  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 {
+  nameWrapperUnwrapEth2ldSnippet,
+  nameWrapperUnwrapSnippet,
+} from '../../contracts/nameWrapper.js'
+import {
+  AdditionalParameterSpecifiedError,
+  RequiredParameterNotSpecifiedError,
+} from '../../errors/general.js'
+import type { ErrorType } from '../../errors/utils.js'
+import type {
+  Eth2ldNameSpecifier,
+  GetNameType,
+  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'
+
+export type UnwrapNameWriteParametersParameters<name extends string> = {
+  /** The name to unwrap */
+  name: name
+  /** The recipient of the unwrapped name */
+  newOwnerAddress: Address
+  /** The registrant of the unwrapped name (eth-2ld only) */
+  newRegistrantAddress?: Address
+} & (GetNameType<name> extends Eth2ldNameSpecifier
+  ? {
+      newRegistrantAddress: Address
+    }
+  : {
+      newRegistrantAddress?: never
+    })
+
+// type ChainWithContractDependencies = ChainWithContract<"ensNameWrapper">;
+
+export type UnwrapNameWriteParametersErrorType =
+  | MakeLabelNodeAndParentErrorType
+  | AdditionalParameterSpecifiedError
+  | RequiredParameterNotSpecifiedError
+  | GetChainContractAddressErrorType
+  | ErrorType
+
+export const unwrapNameWriteParameters = <
+  name extends string,
+  chain extends Chain,
+  account extends Account,
+>(
+  client: RequireClientContracts<chain, 'ensNameWrapper', account>,
+  {
+    name,
+    newOwnerAddress,
+    newRegistrantAddress,
+  }: UnwrapNameWriteParametersParameters<name>,
+) => {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const { labelhash, parentNode } = makeLabelNodeAndParent(name)
+  const nameWrapperAddress = getChainContractAddress({
+    chain: client.chain,
+    contract: 'ensNameWrapper',
+  })
+  const nameType = getNameType(name)
+
+  if (nameType === 'eth-2ld') {
+    if (!newRegistrantAddress)
+      throw new RequiredParameterNotSpecifiedError({
+        parameter: 'newRegistrantAddress',
+        details: 'Must provide newRegistrantAddress for eth-2ld names',
+      })
+
+    return {
+      address: nameWrapperAddress,
+      abi: nameWrapperUnwrapEth2ldSnippet,
+      functionName: 'unwrapETH2LD',
+      args: [labelhash, newRegistrantAddress, newOwnerAddress],
+      chain: client.chain,
+      account: client.account,
+    } as const satisfies WriteContractParameters<
+      typeof nameWrapperUnwrapEth2ldSnippet
+    >
+  }
+
+  if (newRegistrantAddress)
+    throw new AdditionalParameterSpecifiedError({
+      parameter: 'newRegistrantAddress',
+      allowedParameters: ['name', 'newOwnerAddress'],
+      details: 'newRegistrantAddress can only be specified for eth-2ld names',
+    })
+
+  return {
+    address: nameWrapperAddress,
+    abi: nameWrapperUnwrapSnippet,
+    functionName: 'unwrap',
+    args: [parentNode, labelhash, newOwnerAddress],
+    chain: client.chain,
+    account: client.account,
+  } as const satisfies WriteContractParameters<typeof nameWrapperUnwrapSnippet>
+}
+
+// ================================
+// Action
+// ================================
+
+export type UnwrapNameParameters<
+  name extends string,
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends ChainWithContracts<'ensNameWrapper'>,
+> = UnwrapNameWriteParametersParameters<name> &
+  WriteTransactionParameters<chain, account, chainOverride>
+
+export type UnwrapNameReturnType = Hash
+
+export type UnwrapNameErrorType =
+  | UnwrapNameWriteParametersErrorType
+  | ClientWithOverridesErrorType
+  | WriteContractErrorType
+
+/**
+ * Unwraps a name.
+ * @param client - {@link Client}
+ * @param options - {@link UnwrapNameParameters}
+ * @returns Transaction hash. {@link UnwrapNameReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { unwrapName } from '@ensdomains/ensjs/wallet'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const hash = await unwrapName(wallet, {
+ *   name: 'example.eth',
+ *   newOwnerAddress: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ *   newRegistrantAddress: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ * })
+ * // 0x...
+ */
+export async function unwrapName<
+  name extends string,
+  chain extends Chain,
+  account extends Account,
+  chainOverride extends ChainWithContracts<'ensNameWrapper'>,
+>(
+  client: RequireClientContracts<chain, 'ensNameWrapper', account>,
+  {
+    name,
+    newOwnerAddress,
+    newRegistrantAddress,
+    ...txArgs
+  }: UnwrapNameParameters<name, chain, account, chainOverride>,
+): Promise<UnwrapNameReturnType> {
+  ASSERT_NO_TYPE_ERROR(client)
+
+  const writeParameters = unwrapNameWriteParameters(
+    clientWithOverrides(client, txArgs),
+    {
+      name,
+      newOwnerAddress,
+      newRegistrantAddress,
+    } as UnwrapNameWriteParametersParameters<name>,
+  )
+  const writeContractAction = getAction(client, writeContract, 'writeContract')
+  return writeContractAction({
+    ...writeParameters,
+    ...txArgs,
+  } as WriteContractParameters)
+}