@ensdomains/ensjs 4.1.2 → 5.0.0-alpha.1

package/src/functions/wallet/legacyRegisterName.ts

@@ -1,159 +0,0 @@
-import {
-  type Account,
-  type Hash,
-  type SendTransactionParameters,
-  type Transport,
-  encodeFunctionData,
-} from 'viem'
-import { sendTransaction } from 'viem/actions'
-import type { ChainWithEns, ClientWithAccount } from '../../contracts/consts.js'
-import { getChainContractAddress } from '../../contracts/getChainContractAddress.js'
-import {
-  legacyEthRegistrarControllerRegisterSnippet,
-  legacyEthRegistrarControllerRegisterWithConfigSnippet,
-} from '../../contracts/legacyEthRegistrarController.js'
-import { UnsupportedNameTypeError } from '../../errors/general.js'
-import type {
-  Prettify,
-  SimpleTransactionRequest,
-  WriteTransactionParameters,
-} from '../../types.js'
-import { getNameType } from '../../utils/getNameType.js'
-import {
-  type LegacyRegistrationParameters,
-  isLegacyRegistrationWithConfigParameters,
-  makeLegacyRegistrationTuple,
-  makeLegacyRegistrationWithConfigTuple,
-} from '../../utils/legacyRegisterHelpers.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',
-    })
-
-  return {
-    to: getChainContractAddress({
-      client: wallet,
-      contract: 'legacyEthRegistrarController',
-    }),
-    data: isLegacyRegistrationWithConfigParameters(args)
-      ? encodeFunctionData({
-          abi: legacyEthRegistrarControllerRegisterWithConfigSnippet,
-          functionName: 'registerWithConfig',
-          args: makeLegacyRegistrationWithConfigTuple(args),
-        })
-      : encodeFunctionData({
-          abi: legacyEthRegistrarControllerRegisterSnippet,
-          functionName: 'register',
-          args: makeLegacyRegistrationTuple(args),
-        }),
-    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/functions/wallet/registerName.ts

@@ -1,156 +0,0 @@
-import {
-  type Account,
-  type Hash,
-  type SendTransactionParameters,
-  type Transport,
-  encodeFunctionData,
-} from 'viem'
-import { sendTransaction } from 'viem/actions'
-import type { ChainWithEns, ClientWithAccount } from '../../contracts/consts.js'
-import { ethRegistrarControllerRegisterSnippet } from '../../contracts/ethRegistrarController.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 {
-  type RegistrationParameters,
-  makeRegistrationTuple,
-} from '../../utils/registerHelpers.js'
-import { wrappedLabelLengthCheck } from '../../utils/wrapper.js'
-
-export type RegisterNameDataParameters = RegistrationParameters & {
-  /** Value of registration */
-  value: bigint
-}
-
-export type RegisterNameDataReturnType = SimpleTransactionRequest & {
-  value: bigint
-}
-
-export type RegisterNameParameters<
-  TChain extends ChainWithEns,
-  TAccount extends Account | undefined,
-  TChainOverride extends ChainWithEns | undefined,
-> = Prettify<
-  RegisterNameDataParameters &
-    WriteTransactionParameters<TChain, TAccount, TChainOverride>
->
-
-export type RegisterNameReturnType = Hash
-
-export const makeFunctionData = <
-  TChain extends ChainWithEns,
-  TAccount extends Account | undefined,
->(
-  wallet: ClientWithAccount<Transport, TChain, TAccount>,
-  { value, ...args }: RegisterNameDataParameters,
-): RegisterNameDataReturnType => {
-  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 labels = args.name.split('.')
-  wrappedLabelLengthCheck(labels[0])
-
-  return {
-    to: getChainContractAddress({
-      client: wallet,
-      contract: 'ensEthRegistrarController',
-    }),
-    data: encodeFunctionData({
-      abi: ethRegistrarControllerRegisterSnippet,
-      functionName: 'register',
-      args: makeRegistrationTuple(args),
-    }),
-    value,
-  }
-}
-
-/**
- * Registers a name on ENS
- * @param wallet - {@link ClientWithAccount}
- * @param parameters - {@link RegisterNameParameters}
- * @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 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 registerName<
-  TChain extends ChainWithEns,
-  TAccount extends Account | undefined,
-  TChainOverride extends ChainWithEns | undefined = ChainWithEns,
->(
-  wallet: ClientWithAccount<Transport, TChain, TAccount>,
-  {
-    name,
-    owner,
-    duration,
-    secret,
-    resolverAddress,
-    records,
-    reverseRecord,
-    fuses,
-    value,
-    ...txArgs
-  }: RegisterNameParameters<TChain, TAccount, TChainOverride>,
-): Promise<RegisterNameReturnType> {
-  const data = makeFunctionData(wallet, {
-    name,
-    owner,
-    duration,
-    secret,
-    resolverAddress,
-    records,
-    reverseRecord,
-    fuses,
-    value,
-  })
-  const writeArgs = {
-    ...data,
-    ...txArgs,
-  } as SendTransactionParameters<TChain, TAccount, TChainOverride>
-  return sendTransaction(wallet, writeArgs)
-}
-
-registerName.makeFunctionData = makeFunctionData
-
-export default registerName

package/src/functions/wallet/renewNames.ts

@@ -1,153 +0,0 @@
-import {
-  type Account,
-  type Hash,
-  type SendTransactionParameters,
-  type Transport,
-  encodeFunctionData,
-} from 'viem'
-import { sendTransaction } from 'viem/actions'
-import { bulkRenewalRenewAllSnippet } from '../../contracts/bulkRenewal.js'
-import type { ChainWithEns, ClientWithAccount } from '../../contracts/consts.js'
-import { ethRegistrarControllerRenewSnippet } from '../../contracts/ethRegistrarController.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'
-
-export type RenewNamesDataParameters = {
-  /** Name or names to renew */
-  nameOrNames: string | string[]
-  /** Duration to renew name(s) for */
-  duration: bigint | number
-  /** Value of all renewals */
-  value: bigint
-}
-
-export type RenewNamesDataReturnType = SimpleTransactionRequest & {
-  value: bigint
-}
-
-export type RenewNamesParameters<
-  TChain extends ChainWithEns,
-  TAccount extends Account | undefined,
-  TChainOverride extends ChainWithEns | undefined,
-> = Prettify<
-  RenewNamesDataParameters &
-    WriteTransactionParameters<TChain, TAccount, TChainOverride>
->
-
-export type RenewNamesReturnType = Hash
-
-export const makeFunctionData = <
-  TChain extends ChainWithEns,
-  TAccount extends Account | undefined,
->(
-  wallet: ClientWithAccount<Transport, TChain, TAccount>,
-  { nameOrNames, duration, value }: RenewNamesDataParameters,
-): RenewNamesDataReturnType => {
-  const names = Array.isArray(nameOrNames) ? nameOrNames : [nameOrNames]
-  const labels = names.map((name) => {
-    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',
-      })
-    return label[0]
-  })
-
-  if (labels.length === 1) {
-    return {
-      to: getChainContractAddress({
-        client: wallet,
-        contract: 'ensEthRegistrarController',
-      }),
-      data: encodeFunctionData({
-        abi: ethRegistrarControllerRenewSnippet,
-        functionName: 'renew',
-        args: [labels[0], BigInt(duration)],
-      }),
-      value,
-    }
-  }
-
-  return {
-    to: getChainContractAddress({
-      client: wallet,
-      contract: 'ensBulkRenewal',
-    }),
-    data: encodeFunctionData({
-      abi: bulkRenewalRenewAllSnippet,
-      functionName: 'renewAll',
-      args: [labels, BigInt(duration)],
-    }),
-    value,
-  }
-}
-
-/**
- * Renews a name or names for a specified duration.
- * @param wallet - {@link ClientWithAccount}
- * @param parameters - {@link RenewNamesParameters}
- * @returns Transaction hash. {@link RenewNamesReturnType}
- *
- * @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 { renewNames } 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 duration = 31536000 // 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...
- */
-async function renewNames<
-  TChain extends ChainWithEns,
-  TAccount extends Account | undefined,
-  TChainOverride extends ChainWithEns | undefined = ChainWithEns,
->(
-  wallet: ClientWithAccount<Transport, TChain, TAccount>,
-  {
-    nameOrNames,
-    duration,
-    value,
-    ...txArgs
-  }: RenewNamesParameters<TChain, TAccount, TChainOverride>,
-): Promise<RenewNamesReturnType> {
-  const data = makeFunctionData(wallet, { nameOrNames, duration, value })
-  const writeArgs = {
-    ...data,
-    ...txArgs,
-  } as SendTransactionParameters<TChain, TAccount, TChainOverride>
-  return sendTransaction(wallet, writeArgs)
-}
-
-renewNames.makeFunctionData = makeFunctionData
-
-export default renewNames

package/src/functions/wallet/setAbiRecord.ts

@@ -1,114 +0,0 @@
-import type {
-  Account,
-  Address,
-  Hash,
-  SendTransactionParameters,
-  Transport,
-} from 'viem'
-import { sendTransaction } from 'viem/actions'
-import type { ChainWithEns, ClientWithAccount } from '../../contracts/consts.js'
-import type {
-  Prettify,
-  SimpleTransactionRequest,
-  WriteTransactionParameters,
-} from '../../types.js'
-import type { EncodedAbi } from '../../utils/encoders/encodeAbi.js'
-import {
-  type EncodeSetAbiParameters,
-  encodeSetAbi,
-} from '../../utils/encoders/encodeSetAbi.js'
-import { namehash } from '../../utils/normalise.js'
-
-export type SetAbiRecordDataParameters = {
-  /** Name to set ABI for */
-  name: string
-  /** Encoded ABI data to set */
-  encodedAbi: EncodedAbi
-  /** Resolver address to set ABI on */
-  resolverAddress: Address
-}
-
-export type SetAbiRecordDataReturnType = SimpleTransactionRequest
-
-export type SetAbiRecordParameters<
-  TChain extends ChainWithEns,
-  TAccount extends Account | undefined,
-  TChainOverride extends ChainWithEns | undefined,
-> = Prettify<
-  SetAbiRecordDataParameters &
-    WriteTransactionParameters<TChain, TAccount, TChainOverride>
->
-
-export type SetAbiRecordReturnType = Hash
-
-export const makeFunctionData = <
-  TChain extends ChainWithEns,
-  TAccount extends Account | undefined,
->(
-  _wallet: ClientWithAccount<Transport, TChain, TAccount>,
-  { name, encodedAbi, resolverAddress }: SetAbiRecordDataParameters,
-): SetAbiRecordDataReturnType => {
-  return {
-    to: resolverAddress,
-    data: encodeSetAbi({
-      namehash: namehash(name),
-      ...encodedAbi,
-    } as EncodeSetAbiParameters),
-  }
-}
-
-/**
- * Sets the ABI for a name on a resolver.
- * @param wallet - {@link ClientWithAccount}
- * @param parameters - {@link SetAbiRecordParameters}
- * @returns Transaction hash. {@link SetAbiRecordReturnType}
- *
- * @example
- * import abi from './abi.json'
- * import { createWalletClient, custom } from 'viem'
- * import { mainnet } from 'viem/chains'
- * import { addEnsContracts } from '@ensdomains/ensjs'
- * import { encodeAbi } from '@ensdomains/ensjs/utils'
- * import { setAbiRecord } from '@ensdomains/ensjs/wallet'
- *
- * const wallet = createWalletClient({
- *   chain: addEnsContracts(mainnet),
- *   transport: custom(window.ethereum),
- * })
- *
- * const encodedAbi = await encodeAbi({ encodeAs: 'json', abi })
- * const hash = await setAbiRecord(wallet, {
- *   name: 'ens.eth',
- *   encodedAbi,
- *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
- * })
- * // 0x...
- */
-async function setAbiRecord<
-  TChain extends ChainWithEns,
-  TAccount extends Account | undefined,
-  TChainOverride extends ChainWithEns | undefined = ChainWithEns,
->(
-  wallet: ClientWithAccount<Transport, TChain, TAccount>,
-  {
-    name,
-    encodedAbi,
-    resolverAddress,
-    ...txArgs
-  }: SetAbiRecordParameters<TChain, TAccount, TChainOverride>,
-): Promise<SetAbiRecordReturnType> {
-  const data = makeFunctionData(wallet, {
-    name,
-    encodedAbi,
-    resolverAddress,
-  })
-  const writeArgs = {
-    ...data,
-    ...txArgs,
-  } as SendTransactionParameters<TChain, TAccount, TChainOverride>
-  return sendTransaction(wallet, writeArgs)
-}
-
-setAbiRecord.makeFunctionData = makeFunctionData
-
-export default setAbiRecord

package/src/functions/wallet/setAddressRecord.ts

@@ -1,108 +0,0 @@
-import type {
-  Account,
-  Address,
-  Hash,
-  SendTransactionParameters,
-  Transport,
-} from 'viem'
-import { sendTransaction } from 'viem/actions'
-import type { ChainWithEns, ClientWithAccount } from '../../contracts/consts.js'
-import type {
-  Prettify,
-  SimpleTransactionRequest,
-  WriteTransactionParameters,
-} from '../../types.js'
-import { encodeSetAddr } from '../../utils/encoders/encodeSetAddr.js'
-import { namehash } from '../../utils/normalise.js'
-
-export type SetAddressRecordDataParameters = {
-  /** Name to set address record for */
-  name: string
-  /** Coin ticker or ID to set */
-  coin: string | number
-  /** Value to set, null if deleting */
-  value: Address | string | null
-  /** Resolver address to set address record on */
-  resolverAddress: Address
-}
-
-export type SetAddressRecordDataReturnType = SimpleTransactionRequest
-
-export type SetAddressRecordParameters<
-  TChain extends ChainWithEns,
-  TAccount extends Account | undefined,
-  TChainOverride extends ChainWithEns | undefined,
-> = Prettify<
-  SetAddressRecordDataParameters &
-    WriteTransactionParameters<TChain, TAccount, TChainOverride>
->
-
-export type SetAddressRecordReturnType = Hash
-
-export const makeFunctionData = <
-  TChain extends ChainWithEns,
-  TAccount extends Account | undefined,
->(
-  _wallet: ClientWithAccount<Transport, TChain, TAccount>,
-  { name, coin, value, resolverAddress }: SetAddressRecordDataParameters,
-): SetAddressRecordDataReturnType => {
-  return {
-    to: resolverAddress,
-    data: encodeSetAddr({ namehash: namehash(name), coin, value }),
-  }
-}
-
-/**
- * Sets an address record for a name on a resolver.
- * @param wallet - {@link ClientWithAccount}
- * @param parameters - {@link SetAddressRecordParameters}
- * @returns Transaction hash. {@link SetAddressRecordReturnType}
- *
- * @example
- * import { createWalletClient, custom } from 'viem'
- * import { mainnet } from 'viem/chains'
- * import { addEnsContracts } from '@ensdomains/ensjs'
- * import { setAddressRecord } from '@ensdomains/ensjs/wallet'
- *
- * const wallet = createWalletClient({
- *   chain: addEnsContracts(mainnet),
- *   transport: custom(window.ethereum),
- * })
- * const hash = await setAddressRecord(wallet, {
- *   name: 'ens.eth',
- *   coin: 'ETH',
- *   value: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7',
- *   resolverAddress: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',
- * })
- * // 0x...
- */
-async function setAddressRecord<
-  TChain extends ChainWithEns,
-  TAccount extends Account | undefined,
-  TChainOverride extends ChainWithEns | undefined = ChainWithEns,
->(
-  wallet: ClientWithAccount<Transport, TChain, TAccount>,
-  {
-    name,
-    coin,
-    value,
-    resolverAddress,
-    ...txArgs
-  }: SetAddressRecordParameters<TChain, TAccount, TChainOverride>,
-): Promise<SetAddressRecordReturnType> {
-  const data = makeFunctionData(wallet, {
-    name,
-    coin,
-    value,
-    resolverAddress,
-  })
-  const writeArgs = {
-    ...data,
-    ...txArgs,
-  } as SendTransactionParameters<TChain, TAccount, TChainOverride>
-  return sendTransaction(wallet, writeArgs)
-}
-
-setAddressRecord.makeFunctionData = makeFunctionData
-
-export default setAddressRecord