@ensdomains/ensjs 4.0.2 → 4.0.3-alpha.0

package/src/errors/version.ts

@@ -1 +1 @@
-export const version = 'v4.0.2-alpha.5'
+export const version = 'v4.0.3-alpha.0'

package/src/functions/wallet/legacyCommitName.ts

@@ -0,0 +1,127 @@
+import {
+  encodeFunctionData,
+  type Account,
+  type Hash,
+  type SendTransactionParameters,
+  type Transport,
+} from 'viem'
+import { sendTransaction } from 'viem/actions'
+import type { ChainWithEns, ClientWithAccount } from '../../contracts/consts.js'
+import { legacyEthRegistrarControllerCommitSnippet } from '../../contracts/legacyEthRegistrarController.js'
+import { getChainContractAddress } from '../../contracts/getChainContractAddress.js'
+import { UnsupportedNameTypeError } from '../../errors/general.js'
+import type {
+  Prettify,
+  SimpleTransactionRequest,
+  WriteTransactionParameters,
+} from '../../types.js'
+import { getNameType } from '../../utils/getNameType.js'
+import {
+  makeLegacyCommitment,
+  type LegacyRegistrationParameters,
+} from '../../utils/legacyRegisterHelpers.js'
+import { EMPTY_ADDRESS } from '../../utils/consts.js'
+
+export type LegacyCommitNameDataParameters = LegacyRegistrationParameters
+
+export type LegacyCommitNameDataReturnType = SimpleTransactionRequest
+
+export type LegacyCommitNameParameters<
+  TChain extends ChainWithEns,
+  TAccount extends Account | undefined,
+  TChainOverride extends ChainWithEns | undefined,
+> = Prettify<
+  LegacyCommitNameDataParameters &
+    WriteTransactionParameters<TChain, TAccount, TChainOverride>
+>
+
+export type LegacyCommitNameReturnType = Hash
+
+export const makeFunctionData = <
+  TChain extends ChainWithEns,
+  TAccount extends Account | undefined,
+>(
+  wallet: ClientWithAccount<Transport, TChain, TAccount>,
+  args: LegacyCommitNameDataParameters,
+): LegacyCommitNameDataReturnType => {
+  const nameType = getNameType(args.name)
+  if (nameType !== 'eth-2ld')
+    throw new UnsupportedNameTypeError({
+      nameType,
+      supportedNameTypes: ['eth-2ld'],
+      details: 'Only 2ld-eth name registration is supported',
+    })
+
+  return {
+    to: getChainContractAddress({
+      client: wallet,
+      contract: 'legacyEthRegistrarController',
+    }),
+    data: encodeFunctionData({
+      abi: legacyEthRegistrarControllerCommitSnippet,
+      functionName: 'commit',
+      args: [makeLegacyCommitment(args)],
+    }),
+  }
+}
+
+/**
+ * Commits a name to be registered
+ * @param wallet - {@link ClientWithAccount}
+ * @param parameters - {@link LegacyCommitNameParameters}
+ * @returns Transaction hash. {@link LegacyCommitNameReturnType}
+ *
+ * @example
+ * import { createWalletClient, custom } from 'viem'
+ * import { mainnet } from 'viem/chains'
+ * import { addEnsContracts } from '@ensdomains/ensjs'
+ * import { commitName } from '@ensdomains/ensjs/wallet'
+ * import { randomSecret } from '@ensdomains/ensjs/utils'
+ *
+ * const wallet = createWalletClient({
+ *   chain: addEnsContracts(mainnet),
+ *   transport: custom(window.ethereum),
+ * })
+ * const secret = randomSecret()
+ * const hash = await commitName(wallet, {
+ *   name: 'example.eth',
+ *   owner: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
+ *   duration: 31536000, // 1 year
+ *   secret,
+ * })
+ * // 0x...
+ */
+async function legacyCommitName<
+  TChain extends ChainWithEns,
+  TAccount extends Account | undefined,
+  TChainOverride extends ChainWithEns | undefined = ChainWithEns,
+>(
+  wallet: ClientWithAccount<Transport, TChain, TAccount>,
+  {
+    name,
+    owner,
+    duration,
+    secret,
+    resolverAddress = EMPTY_ADDRESS,
+    address = EMPTY_ADDRESS,
+    ...txArgs
+  }: LegacyCommitNameParameters<TChain, TAccount, TChainOverride>,
+): Promise<LegacyCommitNameReturnType> {
+  const data = makeFunctionData(wallet, {
+    name,
+    owner,
+    duration,
+    secret,
+    resolverAddress,
+    address,
+  })
+  const writeArgs = {
+    ...data,
+    ...txArgs,
+  } as SendTransactionParameters<TChain, TAccount, TChainOverride>
+  return sendTransaction(wallet, writeArgs)
+}
+
+legacyCommitName.makeFunctionData = makeFunctionData
+
+export default legacyCommitName

package/src/functions/wallet/legacyRegisterName.ts

@@ -0,0 +1,160 @@
+import {
+  encodeFunctionData,
+  type Account,
+  type Hash,
+  type SendTransactionParameters,
+  type Transport,
+} from 'viem'
+import { sendTransaction } from 'viem/actions'
+import type { ChainWithEns, ClientWithAccount } from '../../contracts/consts.js'
+import { getChainContractAddress } from '../../contracts/getChainContractAddress.js'
+import { UnsupportedNameTypeError } from '../../errors/general.js'
+import type {
+  Prettify,
+  SimpleTransactionRequest,
+  WriteTransactionParameters,
+} from '../../types.js'
+import { getNameType } from '../../utils/getNameType.js'
+import {
+  makeLegacyRegistrationTuple,
+  type LegacyRegistrationParameters,
+  isLegacyRegistrationWithConfig,
+} from '../../utils/legacyRegisterHelpers.js'
+import {
+  legacyEthRegistrarControllerRegisterSnippet,
+  legacyEthRegistrarControllerRegisterWithConfigSnippet,
+} from '../../contracts/legacyEthRegistrarController.js'
+
+export type LegacyRegisterNameDataParameters = LegacyRegistrationParameters & {
+  /** Value of registration */
+  value: bigint
+}
+
+export type LegacyRegisterNameDataReturnType = SimpleTransactionRequest & {
+  value: bigint
+}
+
+export type LegacyRegisterNameParameters<
+  TChain extends ChainWithEns,
+  TAccount extends Account | undefined,
+  TChainOverride extends ChainWithEns | undefined,
+> = Prettify<
+  LegacyRegisterNameDataParameters &
+    WriteTransactionParameters<TChain, TAccount, TChainOverride>
+>
+
+export type LegacyRegisterNameReturnType = Hash
+
+export const makeFunctionData = <
+  TChain extends ChainWithEns,
+  TAccount extends Account | undefined,
+>(
+  wallet: ClientWithAccount<Transport, TChain, TAccount>,
+  { value, ...args }: LegacyRegisterNameDataParameters,
+): LegacyRegisterNameDataReturnType => {
+  const nameType = getNameType(args.name)
+  if (nameType !== 'eth-2ld')
+    throw new UnsupportedNameTypeError({
+      nameType,
+      supportedNameTypes: ['eth-2ld'],
+      details: 'Only 2ld-eth name registration is supported',
+    })
+
+  const data = isLegacyRegistrationWithConfig(args)
+    ? encodeFunctionData({
+        abi: legacyEthRegistrarControllerRegisterWithConfigSnippet,
+        functionName: 'registerWithConfig',
+        args: makeLegacyRegistrationTuple(args),
+      })
+    : encodeFunctionData({
+        abi: legacyEthRegistrarControllerRegisterSnippet,
+        functionName: 'register',
+        args: makeLegacyRegistrationTuple(args),
+      })
+
+  return {
+    to: getChainContractAddress({
+      client: wallet,
+      contract: 'legacyEthRegistrarController',
+    }),
+    data,
+    value,
+  }
+}
+
+/**
+ * Registers a name on ENS
+ * @param wallet - {@link ClientWithAccount}
+ * @param parameters - {@link RegisterNameParameters}
+ * @returns Transaction hash. {@link LegacyRegisterNameReturnType}
+ *
+ * @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 client = 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 client.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(client, { 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...
+ */
+async function legacyRegisterName<
+  TChain extends ChainWithEns,
+  TAccount extends Account | undefined,
+  TChainOverride extends ChainWithEns | undefined = ChainWithEns,
+>(
+  wallet: ClientWithAccount<Transport, TChain, TAccount>,
+  {
+    name,
+    owner,
+    duration,
+    secret,
+    resolverAddress,
+    address,
+    value,
+    ...txArgs
+  }: LegacyRegisterNameParameters<TChain, TAccount, TChainOverride>,
+): Promise<LegacyRegisterNameReturnType> {
+  const data = makeFunctionData(wallet, {
+    name,
+    owner,
+    duration,
+    secret,
+    resolverAddress,
+    address,
+    value,
+  })
+  const writeArgs = {
+    ...data,
+    ...txArgs,
+  } as SendTransactionParameters<TChain, TAccount, TChainOverride>
+  return sendTransaction(wallet, writeArgs)
+}
+
+legacyRegisterName.makeFunctionData = makeFunctionData
+
+export default legacyRegisterName

package/src/utils/index.ts

@@ -104,6 +104,15 @@ export {
   saveLabel,
   saveName,
 } from './labels.js'
+export {
+  makeLegacyCommitment,
+  makeLegacyCommitmentFromTuple,
+  makeLegacyCommitmentTuple,
+  makeLegacyRegistrationTuple,
+  type LegacyCommitmentTuple,
+  type LegacyRegistrationParameters,
+  type LegacyRegistrationTuple,
+} from './legacyRegisterHelpers.js'
 export { makeSafeSecondsDate } from './makeSafeSecondsDate.js'
 export {
   beautify,

package/src/utils/legacyRegisterHelpers.ts

@@ -0,0 +1,134 @@
+import {
+  keccak256,
+  labelhash,
+  type Address,
+  type Hex,
+  encodePacked,
+} from 'viem'
+import { EMPTY_ADDRESS } from './consts.js'
+import { LegacyRegistrationInvalidConfigError } from '../errors/register.js'
+
+export type LegacyRegistrationBaseParameters = {
+  /** Name to register */
+  name: string
+  /** Address to set owner to */
+  owner: Address
+  /** Duration of registration */
+  duration: number
+  /** Random 32 bytes to use for registration */
+  secret: Hex
+  /** Custom resolver address, defaults to empty address */
+  resolverAddress?: Address
+  /** Address to set upon registration, defaults to empty address */
+  address?: Address
+}
+
+export type LegacyRegistrationWithConfigParameters =
+  LegacyRegistrationBaseParameters & {
+    resolverAddress: Address
+    address?: Address
+  }
+
+export type LegacyRegistrationParameters =
+  | LegacyRegistrationBaseParameters
+  | LegacyRegistrationWithConfigParameters
+
+export const isLegacyRegistrationWithConfig = (
+  params: LegacyRegistrationParameters,
+): params is LegacyRegistrationWithConfigParameters => {
+  const { resolverAddress = EMPTY_ADDRESS, address = EMPTY_ADDRESS } =
+    params as LegacyRegistrationWithConfigParameters
+
+  if (resolverAddress === EMPTY_ADDRESS && address !== EMPTY_ADDRESS)
+    throw new LegacyRegistrationInvalidConfigError({
+      resolverAddress,
+      address,
+    })
+  return resolverAddress !== EMPTY_ADDRESS || address !== EMPTY_ADDRESS
+}
+
+export type LegacyCommitmentTuple =
+  | [label: string, owner: Address, secret: Hex]
+  | [
+      label: string,
+      owner: Address,
+      resolverAddress: Address,
+      address: Address,
+      secret: Hex,
+    ]
+
+export type LegacyRegistrationTuple =
+  | [label: string, owner: Address, duration: bigint, secret: Hex]
+  | [
+      label: string,
+      owner: Address,
+      duration: bigint,
+      secret: Hex,
+      resolverAddress: Address,
+      address: Address,
+    ]
+
+export const makeLegacyCommitmentTuple = (
+  params: LegacyRegistrationParameters,
+): LegacyCommitmentTuple => {
+  const {
+    name,
+    owner,
+    secret,
+    resolverAddress = EMPTY_ADDRESS,
+    address = EMPTY_ADDRESS,
+  } = params as LegacyRegistrationWithConfigParameters
+
+  const label = name.split('.')[0]
+
+  if (isLegacyRegistrationWithConfig(params)) {
+    return [label, owner, secret, resolverAddress, address]
+  }
+  return [label, owner, secret]
+}
+
+export const makeLegacyRegistrationTuple = (
+  params: LegacyRegistrationParameters,
+): LegacyRegistrationTuple => {
+  const {
+    name,
+    owner,
+    secret,
+    duration,
+    resolverAddress = EMPTY_ADDRESS,
+    address = EMPTY_ADDRESS,
+  } = params as LegacyRegistrationWithConfigParameters
+  const label = name.split('.')[0]
+  if (isLegacyRegistrationWithConfig(params))
+    return [label, owner, BigInt(duration), secret, resolverAddress, address]
+  return [label, owner, BigInt(params.duration), secret]
+}
+
+export const makeLegacyCommitmentFromTuple = ([
+  label,
+  ...others
+]: LegacyCommitmentTuple): Hex => {
+  const labelHash = labelhash(label)
+  const params = [labelHash, ...others] as const
+
+  if (params.length === 3)
+    return keccak256(encodePacked(['bytes32', 'address', 'bytes32'], params))
+
+  const [
+    owner,
+    secret,
+    resolverAddress = EMPTY_ADDRESS,
+    address = EMPTY_ADDRESS,
+  ] = others
+
+  return keccak256(
+    encodePacked(
+      ['bytes32', 'address', 'address', 'address', 'bytes32'],
+      [labelHash, owner, resolverAddress, address, secret],
+    ),
+  )
+}
+
+export const makeLegacyCommitment = (
+  params: LegacyRegistrationParameters,
+): Hex => makeLegacyCommitmentFromTuple(makeLegacyCommitmentTuple(params))

package/src/wallet.ts

@@ -26,6 +26,20 @@ export {
   type DeleteSubnameParameters,
   type DeleteSubnameReturnType,
 } from './functions/wallet/deleteSubname.js'
+export {
+  default as legacyCommitName,
+  type LegacyCommitNameDataParameters,
+  type LegacyCommitNameDataReturnType,
+  type LegacyCommitNameParameters,
+  type LegacyCommitNameReturnType,
+} from './functions/wallet/legacyCommitName.js'
+export {
+  default as legacyRegisterName,
+  type LegacyRegisterNameDataParameters,
+  type LegacyRegisterNameDataReturnType,
+  type LegacyRegisterNameParameters,
+  type LegacyRegisterNameReturnType,
+} from './functions/wallet/legacyRegisterName.js'
 export {
   default as registerName,
   type RegisterNameDataParameters,