@ensdomains/ensjs 4.1.2 → 4.2.2

package/dist/utils/legacyRegisterHelpers.js

@@ -1,45 +0,0 @@
-import { encodePacked, keccak256, labelhash, } from 'viem';
-import { LegacyRegistrationInvalidConfigError } from '../errors/register.js';
-import { EMPTY_ADDRESS } from './consts.js';
-export const isLegacyRegistrationWithConfigParameters = (params) => {
-    const { resolverAddress = EMPTY_ADDRESS, address = EMPTY_ADDRESS } = params;
-    if (resolverAddress === EMPTY_ADDRESS && address !== EMPTY_ADDRESS)
-        throw new LegacyRegistrationInvalidConfigError({
-            resolverAddress,
-            address,
-        });
-    return resolverAddress !== EMPTY_ADDRESS || address !== EMPTY_ADDRESS;
-};
-export const makeLegacyCommitmentTuple = (params) => {
-    const { name, owner, secret } = params;
-    const label = name.split('.')[0];
-    return [label, owner, secret];
-};
-export const makeLegacyCommitmentWithConfigTuple = (params) => {
-    const { name, owner, secret, resolverAddress = EMPTY_ADDRESS, address = EMPTY_ADDRESS, } = params;
-    const label = name.split('.')[0];
-    return [label, owner, secret, resolverAddress, address];
-};
-export const makeLegacyRegistrationTuple = ({ name, owner, secret, duration, }) => {
-    const label = name.split('.')[0];
-    return [label, owner, BigInt(duration), secret];
-};
-export const makeLegacyRegistrationWithConfigTuple = ({ name, owner, secret, duration, resolverAddress, address = EMPTY_ADDRESS, }) => {
-    const label = name.split('.')[0];
-    return [label, owner, BigInt(duration), secret, resolverAddress, address];
-};
-export const makeLegacyCommitmentFromTuple = ([label, ...others]) => {
-    const labelHash = labelhash(label);
-    const params = [labelHash, ...others];
-    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) => {
-    const touple = isLegacyRegistrationWithConfigParameters(params)
-        ? makeLegacyCommitmentWithConfigTuple(params)
-        : makeLegacyCommitmentTuple(params);
-    return makeLegacyCommitmentFromTuple(touple);
-};
-//# sourceMappingURL=legacyRegisterHelpers.js.map

package/dist/utils/legacyRegisterHelpers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"legacyRegisterHelpers.js","sourceRoot":"","sources":["../../src/utils/legacyRegisterHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,YAAY,EACZ,SAAS,EACT,SAAS,GACV,MAAM,MAAM,CAAA;AACb,OAAO,EAAE,oCAAoC,EAAE,MAAM,uBAAuB,CAAA;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAuB3C,MAAM,CAAC,MAAM,wCAAwC,GAAG,CACtD,MAAoC,EACc,EAAE;IACpD,MAAM,EAAE,eAAe,GAAG,aAAa,EAAE,OAAO,GAAG,aAAa,EAAE,GAChE,MAAgD,CAAA;IAElD,IAAI,eAAe,KAAK,aAAa,IAAI,OAAO,KAAK,aAAa;QAChE,MAAM,IAAI,oCAAoC,CAAC;YAC7C,eAAe;YACf,OAAO;SACR,CAAC,CAAA;IACJ,OAAO,eAAe,KAAK,aAAa,IAAI,OAAO,KAAK,aAAa,CAAA;AACvE,CAAC,CAAA;AA4BD,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACvC,MAAoC,EACb,EAAE;IACzB,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IAChC,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;AAC/B,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,mCAAmC,GAAG,CACjD,MAA8C,EACb,EAAE;IACnC,MAAM,EACJ,IAAI,EACJ,KAAK,EACL,MAAM,EACN,eAAe,GAAG,aAAa,EAC/B,OAAO,GAAG,aAAa,GACxB,GAAG,MAAgD,CAAA;IACpD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IAChC,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,CAAA;AACzD,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,EAC1C,IAAI,EACJ,KAAK,EACL,MAAM,EACN,QAAQ,GACqB,EAA2B,EAAE;IAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IAChC,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAA;AACjD,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,qCAAqC,GAAG,CAAC,EACpD,IAAI,EACJ,KAAK,EACL,MAAM,EACN,QAAQ,EACR,eAAe,EACf,OAAO,GAAG,aAAa,GACgB,EAAqC,EAAE;IAC9E,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IAChC,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,CAAA;AAC3E,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,EAAE,GAAG,MAAM,CAE5B,EAAO,EAAE;IAC1C,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,CAAA;IAClC,MAAM,MAAM,GAAG,CAAC,SAAS,EAAE,GAAG,MAAM,CAAU,CAAA;IAE9C,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QACrB,OAAO,SAAS,CAAC,YAAY,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,CAAC,CAAA;IAE3E,MAAM,CACJ,KAAK,EACL,MAAM,EACN,eAAe,GAAG,aAAa,EAC/B,OAAO,GAAG,aAAa,EACxB,GAAG,MAAM,CAAA;IAEV,OAAO,SAAS,CACd,YAAY,CACV,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC,EACvD,CAAC,SAAS,EAAE,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,CAAC,CACrD,CACF,CAAA;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,MAA6E,EACxE,EAAE;IACP,MAAM,MAAM,GAAG,wCAAwC,CAAC,MAAM,CAAC;QAC7D,CAAC,CAAC,mCAAmC,CAAC,MAAM,CAAC;QAC7C,CAAC,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;IACrC,OAAO,6BAA6B,CAAC,MAAM,CAAC,CAAA;AAC9C,CAAC,CAAA"}

package/src/functions/wallet/legacyCommitName.ts

@@ -1,127 +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 { legacyEthRegistrarControllerCommitSnippet } from '../../contracts/legacyEthRegistrarController.js'
-import { UnsupportedNameTypeError } from '../../errors/general.js'
-import type {
-  Prettify,
-  SimpleTransactionRequest,
-  WriteTransactionParameters,
-} from '../../types.js'
-import { EMPTY_ADDRESS } from '../../utils/consts.js'
-import { getNameType } from '../../utils/getNameType.js'
-import {
-  type LegacyRegistrationParameters,
-  makeLegacyCommitment,
-} from '../../utils/legacyRegisterHelpers.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

@@ -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/utils/legacyRegisterHelpers.ts

@@ -1,147 +0,0 @@
-import {
-  type Address,
-  type Hex,
-  encodePacked,
-  keccak256,
-  labelhash,
-} from 'viem'
-import { LegacyRegistrationInvalidConfigError } from '../errors/register.js'
-import { EMPTY_ADDRESS } from './consts.js'
-
-export type LegacyRegistrationParameters = {
-  /** 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 =
-  LegacyRegistrationParameters & {
-    resolverAddress: Address
-    address?: Address
-  }
-
-export const isLegacyRegistrationWithConfigParameters = (
-  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]
-
-export type LegacyCommitmentWithConfigTuple = [
-  label: string,
-  owner: Address,
-  resolverAddress: Address,
-  address: Address,
-  secret: Hex,
-]
-
-export type LegacyRegistrationTuple = [
-  label: string,
-  owner: Address,
-  duration: bigint,
-  secret: Hex,
-]
-
-export type LegacyRegistrationWithConfigTuple = [
-  label: string,
-  owner: Address,
-  duration: bigint,
-  secret: Hex,
-  resolverAddress: Address,
-  address: Address,
-]
-
-export const makeLegacyCommitmentTuple = (
-  params: LegacyRegistrationParameters,
-): LegacyCommitmentTuple => {
-  const { name, owner, secret } = params
-  const label = name.split('.')[0]
-  return [label, owner, secret]
-}
-
-export const makeLegacyCommitmentWithConfigTuple = (
-  params: LegacyRegistrationWithConfigParameters,
-): LegacyCommitmentWithConfigTuple => {
-  const {
-    name,
-    owner,
-    secret,
-    resolverAddress = EMPTY_ADDRESS,
-    address = EMPTY_ADDRESS,
-  } = params as LegacyRegistrationWithConfigParameters
-  const label = name.split('.')[0]
-  return [label, owner, secret, resolverAddress, address]
-}
-
-export const makeLegacyRegistrationTuple = ({
-  name,
-  owner,
-  secret,
-  duration,
-}: LegacyRegistrationParameters): LegacyRegistrationTuple => {
-  const label = name.split('.')[0]
-  return [label, owner, BigInt(duration), secret]
-}
-
-export const makeLegacyRegistrationWithConfigTuple = ({
-  name,
-  owner,
-  secret,
-  duration,
-  resolverAddress,
-  address = EMPTY_ADDRESS,
-}: LegacyRegistrationWithConfigParameters): LegacyRegistrationWithConfigTuple => {
-  const label = name.split('.')[0]
-  return [label, owner, BigInt(duration), secret, resolverAddress, address]
-}
-
-export const makeLegacyCommitmentFromTuple = ([label, ...others]:
-  | LegacyCommitmentTuple
-  | LegacyCommitmentWithConfigTuple): 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 | LegacyRegistrationWithConfigParameters,
-): Hex => {
-  const touple = isLegacyRegistrationWithConfigParameters(params)
-    ? makeLegacyCommitmentWithConfigTuple(params)
-    : makeLegacyCommitmentTuple(params)
-  return makeLegacyCommitmentFromTuple(touple)
-}