@ensdomains/ensjs 4.1.1 → 5.0.0-alpha.0

package/src/utils/index.ts

@@ -1,164 +1,36 @@
-export { ccipRequest } from './ccipRequest.js'
-export {
-  getDnsTxtRecords,
-  type GetDnsTxtRecordsParameters,
-  type GetDnsTxtRecordsReturnType,
-} from './dns/getDnsTxtRecords.js'
-export {
-  DnsRecordType,
-  DnsResponseStatus,
-  type DnsQuestionItem,
-  type DnsResponse,
-  type DnsResponseItem,
-} from './dns/misc.js'
-export {
-  contentTypeToEncodeAs,
-  encodeAbi,
-  encodeAsToContentType,
-  type EncodeAbiParameters,
-  type EncodeAbiReturnType,
-  type EncodedAbi,
-} from './encoders/encodeAbi.js'
-export { encodeClearRecords } from './encoders/encodeClearRecords.js'
-export {
-  encodeSetAbi,
-  type EncodeSetAbiParameters,
-  type EncodeSetAbiReturnType,
-} from './encoders/encodeSetAbi.js'
-export {
-  encodeSetAddr,
-  type EncodeSetAddrParameters,
-  type EncodeSetAddrReturnType,
-} from './encoders/encodeSetAddr.js'
-export {
-  encodeSetContentHash,
-  type EncodeSetContentHashParameters,
-  type EncodeSetContentHashReturnType,
-} from './encoders/encodeSetContentHash.js'
-export {
-  encodeSetText,
-  type EncodeSetTextParameters,
-  type EncodeSetTextReturnType,
-} from './encoders/encodeSetText.js'
-
-export {
-  EMPTY_ADDRESS,
-  GRACE_PERIOD_SECONDS,
-  MAX_DATE_INT,
-  MAX_INT_64,
-  MINIMUM_DOT_ETH_CHARS,
-} from './consts.js'
-export {
-  ChildFuseKeys,
-  ChildFuseReference,
-  ChildFuses,
-  FullParentFuseKeys,
-  FullParentFuseReference,
-  FullParentFuses,
-  FuseRanges,
-  ParentFuseKeys,
-  ParentFuseReference,
-  ParentFuses,
-  UnnamedChildFuseKeys,
-  UnnamedChildFuses,
-  UnnamedParentFuseKeys,
-  UnnamedParentFuses,
-  UserSettableFuseKeys,
-  UserSettableFuses,
-  checkPccBurned,
-  decodeFuses,
-  encodeFuses,
-  type ChildFuseReferenceType,
-  type DecodedFuses,
-  type EncodeChildFusesInputObject,
-  type EncodeFusesInputObject,
-  type EncodeParentFusesInputObject,
-  type FullParentFuseReferenceType,
-  type ParentFuseReferenceType,
-} from './fuses.js'
-
-export {
-  decodeContentHash,
-  encodeContentHash,
-  getDisplayCodec,
-  getInternalCodec,
-  getProtocolType,
-  isValidContentHash,
-  type DecodedContentHash,
-  type ProtocolType,
-} from './contentHash.js'
-export { truncateFormat } from './format.js'
-export {
-  generateRecordCallArray,
-  type RecordOptions,
-} from './generateRecordCallArray.js'
-export { generateSupportedContentTypes } from './generateSupportedContentTypes.js'
-export { bytesToPacket, packetToBytes } from './hexEncodedName.js'
-export {
-  checkIsDecrypted,
-  checkLabel,
-  decodeLabelhash,
-  decryptName,
-  encodeLabelhash,
-  isEncodedLabelhash,
-  saveLabel,
-  saveName,
-} from './labels.js'
-export {
-  makeLegacyCommitment,
-  makeLegacyCommitmentFromTuple,
-  makeLegacyCommitmentTuple,
-  makeLegacyCommitmentWithConfigTuple,
-  makeLegacyRegistrationTuple,
-  makeLegacyRegistrationWithConfigTuple,
-  isLegacyRegistrationWithConfigParameters,
-  type LegacyCommitmentTuple,
-  type LegacyCommitmentWithConfigTuple,
-  type LegacyRegistrationParameters,
-  type LegacyRegistrationWithConfigParameters,
-  type LegacyRegistrationTuple,
-  type LegacyRegistrationWithConfigTuple,
-} from './legacyRegisterHelpers.js'
-export { makeSafeSecondsDate } from './makeSafeSecondsDate.js'
-export {
-  beautify,
-  emoji,
-  isCombiningMark,
-  namehash,
-  normalise,
-  normaliseFragment,
-  shouldEscape,
-  split,
-  tokenise,
-  type DisallowedToken,
-  type EmojiToken,
-  type IgnoredToken,
-  type Label,
-  type MappedToken,
-  type NFCToken,
-  type StopToken,
-  type TextToken,
-  type Token,
-  type ValidToken,
-} from './normalise.js'
-export {
-  makeCommitment,
-  makeCommitmentFromTuple,
-  makeCommitmentTuple,
-  makeRegistrationTuple,
-  randomSecret,
-  type CommitmentTuple,
-  type RegistrationParameters,
-  type RegistrationTuple,
-} from './registerHelpers.js'
-export {
-  checkIsDotEth,
-  parseInput,
-  validateName,
-  type ParsedInputResult,
-} from './validation.js'
-export {
-  MAX_EXPIRY,
-  expiryToBigInt,
-  wrappedLabelLengthCheck,
-} from './wrapper.js'
+export * from './ccipBatchRequest.js'
+export * from './ccipRequest.js'
+export * from './clientWithOverrides.js'
+export * from './coders/clearRecords.js'
+export * from './coders/encodeAbi.js'
+export * from './coders/getAbi.js'
+export * from './coders/getAddress.js'
+export * from './coders/getContentHash.js'
+export * from './coders/getText.js'
+export * from './coders/resolverMulticallParameters.js'
+export * from './coders/setAbi.js'
+export * from './coders/setAddr.js'
+export * from './coders/setContentHash.js'
+export * from './coders/setText.js'
+export * from './consts.js'
+export * from './contentHash.js'
+export * from './dns/getDnsTxtRecords.js'
+export * from './dns/misc.js'
+export * from './errors/isNullRegistrarOwnerOfError.js'
+export * from './errors/isNullUniversalResolverError.js'
+export * from './format.js'
+export * from './fuses.js'
+export * from './generateSupportedContentTypes.js'
+export * from './index.js'
+export * from './name/getNameType.js'
+export * from './name/getNameWithSizedLabels.js'
+export * from './name/hexEncodedName.js'
+export * from './name/labels.js'
+export * from './name/makeLabelNodeAndParent.js'
+export * from './name/normalize.js'
+export * from './name/validation.js'
+export * from './normalizeCoinId.js'
+export * from './nullableAddress.js'
+export * from './ownerFromContract.js'
+export * from './registerHelpers.js'
+export * from './wrapper.js'

package/src/utils/l2RegisterHelpers.ts

@@ -0,0 +1,147 @@
+import {
+  type Address,
+  type EncodeAbiParametersErrorType,
+  encodeAbiParameters,
+  type Hex,
+  type Keccak256ErrorType,
+  keccak256,
+  type PadErrorType,
+  pad,
+  type ToBytesErrorType,
+  type ToHexErrorType,
+  toBytes,
+  toHex,
+  zeroAddress,
+} from 'viem'
+import { type NamehashErrorType, namehash } from 'viem/ens'
+import {
+  CampaignReferenceTooLargeError,
+  type ErrorType,
+} from '../errors/utils.js'
+
+export type L2RegistrationParameters = {
+  /** 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
+  /** Subregistry address to use for registration */
+  subregistryAddress?: Address
+  /** Custom resolver address, defaults to current public resolver deployment */
+  resolverAddress?: Address
+}
+
+export type L2CommitmentTuple = [
+  name: string,
+  owner: Address,
+  secret: Hex,
+  subregistry: Address,
+  resolver: Address,
+  duration: bigint,
+]
+
+const cryptoRef =
+  (typeof crypto !== 'undefined' && crypto) ||
+  (typeof window !== 'undefined' &&
+    typeof window.crypto !== 'undefined' &&
+    window.crypto) ||
+  undefined
+
+// ================================
+// Random secret
+// ================================
+
+export type RandomSecretErrorType =
+  | ToBytesErrorType
+  | NamehashErrorType
+  | CampaignReferenceTooLargeError
+  | PadErrorType
+  | ToHexErrorType
+  | ErrorType
+
+export const randomSecret = ({
+  platformDomain,
+  campaign,
+}: {
+  platformDomain?: string
+  campaign?: number
+} = {}) => {
+  const bytes = cryptoRef?.getRandomValues(new Uint8Array(32))!
+  if (platformDomain) {
+    const hash = toBytes(namehash(platformDomain))
+    for (let i = 0; i < 4; i += 1) {
+      bytes[i] = hash[i]
+    }
+  }
+  if (campaign) {
+    if (campaign > 0xffffffff)
+      throw new CampaignReferenceTooLargeError({ campaign })
+    const campaignBytes = pad(toBytes(campaign), { size: 4 })
+    for (let i = 0; i < 4; i += 1) {
+      bytes[i + 4] = campaignBytes[i]
+    }
+  }
+  return toHex(bytes)
+}
+
+// ================================
+// Make L2 commitment tuple
+// ================================
+
+export type MakeL2CommitmentTupleErrorType = ErrorType
+
+export const makeL2CommitmentTuple = ({
+  name,
+  owner,
+  duration,
+  secret,
+  subregistryAddress = zeroAddress,
+  resolverAddress = zeroAddress,
+}: L2RegistrationParameters): L2CommitmentTuple => {
+  return [
+    name,
+    owner,
+    secret,
+    subregistryAddress,
+    resolverAddress,
+    BigInt(duration),
+  ]
+}
+
+// ================================
+// Make L2 commitment from tuple
+// ================================
+
+export type MakeL2CommitmentFromTupleErrorType =
+  | Keccak256ErrorType
+  | EncodeAbiParametersErrorType
+
+export const makeL2CommitmentFromTuple = (params: L2CommitmentTuple): Hex => {
+  return keccak256(
+    encodeAbiParameters(
+      [
+        { name: 'name', type: 'string' },
+        { name: 'owner', type: 'address' },
+        { name: 'secret', type: 'bytes32' },
+        { name: 'subregistry', type: 'address' },
+        { name: 'resolver', type: 'address' },
+        { name: 'duration', type: 'uint64' },
+      ],
+      params,
+    ),
+  )
+}
+
+// ================================
+// Make L2 commitment
+// ================================
+
+export type MakeL2CommitmentErrorType =
+  | MakeL2CommitmentTupleErrorType
+  | MakeL2CommitmentFromTupleErrorType
+
+export const makeL2Commitment = (params: L2RegistrationParameters): Hex =>
+  makeL2CommitmentFromTuple(makeL2CommitmentTuple(params))

package/src/utils/name/getNameType.ts

@@ -0,0 +1,18 @@
+import type { NameType } from '../../types/index.js'
+
+export const getNameType = (name: string): NameType => {
+  const labels = name.split('.')
+  const isDotEth = labels[labels.length - 1] === 'eth'
+
+  if (labels.length === 0) return 'root'
+  if (labels.length === 1) {
+    if (isDotEth) return 'eth-tld'
+    return 'tld'
+  }
+  if (labels.length === 2) {
+    if (isDotEth) return 'eth-2ld'
+    return 'other-2ld'
+  }
+  if (isDotEth) return 'eth-subname'
+  return 'other-subname'
+}

package/src/utils/name/getNameWithSizedLabels.ts

@@ -0,0 +1,28 @@
+import {
+  type LabelhashErrorType,
+  labelhash,
+  type ToBytesErrorType,
+  toBytes,
+} from 'viem'
+import { type EncodeLabelhashErrorType, encodeLabelhash } from './labels.js'
+
+export type GetNameWithSizedLabelsErrorType =
+  | ToBytesErrorType
+  | EncodeLabelhashErrorType
+  | LabelhashErrorType
+
+/**
+ * Ensures a name has labels with a max length of 255 bytes (the max length of labels supported by the universal resolver).
+ */
+export function getNameWithSizedLabels(name: string) {
+  return name
+    .split('.')
+    .map((label) => {
+      const labelLength = toBytes(label).byteLength
+      if (labelLength > 255) {
+        return encodeLabelhash(labelhash(label))
+      }
+      return label
+    })
+    .join('.')
+}

package/src/utils/name/hexEncodedName.ts

@@ -0,0 +1,33 @@
+// Adapted from https://github.com/mafintosh/dns-packet
+import {
+  type ByteArray,
+  type BytesToStringErrorType,
+  bytesToString,
+} from 'viem'
+
+// ================================
+// Bytes To Packet
+// ================================
+
+export type BytesToPacketErrorType = BytesToStringErrorType
+
+/**
+ * @throws {BytesToPacketErrorType}
+ */
+export function bytesToPacket(bytes: ByteArray): string {
+  let offset = 0
+  let result = ''
+
+  while (offset < bytes.length) {
+    const len = bytes[offset]
+    if (len === 0) {
+      offset += 1
+      break
+    }
+
+    result += `${bytesToString(bytes.subarray(offset + 1, offset + len + 1))}.`
+    offset += len + 1
+  }
+
+  return result.replace(/\.$/, '')
+}

package/src/utils/name/labels.ts

@@ -0,0 +1,178 @@
+import { type Hex, type LabelhashErrorType, labelhash } from 'viem'
+import {
+  InvalidEncodedLabelError,
+  InvalidLabelhashError,
+} from '../../errors/utils.js'
+
+const hasLocalStorage = typeof localStorage !== 'undefined'
+
+// ================================
+// Decode Labelhash
+// ================================
+
+export type DecodeLabelhashErrorType = InvalidEncodedLabelError
+
+/**
+ * Decodes an encoded labelhash
+ *
+ * @throws {DecodeLabelhashErrorType}
+ * @param hash - Labelhash to decode
+ * @returns {Hex}
+ */
+export function decodeLabelhash(hash: string): Hex {
+  if (!(hash.startsWith('[') && hash.endsWith(']')))
+    throw new InvalidEncodedLabelError({
+      label: hash,
+      details:
+        'Expected encoded labelhash to start and end with square brackets',
+    })
+
+  if (hash.length !== 66)
+    throw new InvalidEncodedLabelError({
+      label: hash,
+      details: 'Expected encoded labelhash to have a length of 66',
+    })
+
+  return `0x${hash.slice(1, -1)}`
+}
+
+// ================================
+// Encode Labelhash
+// ================================
+
+export type EncodeLabelhashErrorType = InvalidLabelhashError
+
+/**
+ * Encodes a labelhash
+ *
+ * @throws {EncodeLabelhashErrorType}
+ * @param hash - Labelhash to encode
+ * @throws {EncodeLabelhashErrorType}
+ */
+export function encodeLabelhash(hash: string) {
+  if (!hash.startsWith('0x'))
+    throw new InvalidLabelhashError({
+      labelhash: hash,
+      details: 'Expected labelhash to start with 0x',
+    })
+
+  if (hash.length !== 66)
+    throw new InvalidLabelhashError({
+      labelhash: hash,
+      details: 'Expected labelhash to have a length of 66',
+    })
+
+  return `[${hash.slice(2)}]`
+}
+
+export function isEncodedLabelhash(hash: string) {
+  return hash.startsWith('[') && hash.endsWith(']') && hash.length === 66
+}
+
+// ================================
+// Save Label
+// ================================
+
+function _saveLabel(hash: string, label: any) {
+  if (!hasLocalStorage) return hash
+  const labels = getLabels()
+  localStorage.setItem(
+    'ensjs:labels',
+    JSON.stringify({
+      ...labels,
+      [hash]: label,
+    }),
+  )
+  return hash
+}
+
+export type SaveLabelErrorType = LabelhashErrorType
+
+/**
+ * Saves a label to local storage (if available)
+ *
+ * @throws {SaveLabelErrorType}
+ * @param label - Label to save
+ */
+export function saveLabel(label: string) {
+  const hash = `${labelhash(label.toLowerCase())}`
+  return _saveLabel(hash, label)
+}
+
+// ================================
+// Save Name
+// ================================
+
+export type SaveNameErrorType = SaveLabelErrorType
+
+/**
+ * Saves a name to local storage (if available)
+ *
+ * @throws {SaveNameErrorType}
+ * @param name - Name to save
+ */
+export function saveName(name: string) {
+  const nameArray = name.split('.')
+  for (const label of nameArray) {
+    if (!isEncodedLabelhash(label)) {
+      saveLabel(label)
+    }
+  }
+}
+
+// ================================
+// Check Label
+// ================================
+
+export type CheckLabelErrorType = DecodeLabelhashErrorType
+
+/**
+ * Checks a label
+ *
+ * @throws {CheckLabelErrorType}
+ * @param hash - Label to check
+ */
+export function checkLabel(hash: string): string {
+  const labels = getLabels()
+  if (isEncodedLabelhash(hash)) {
+    return labels[decodeLabelhash(hash)] || hash
+  }
+  return hash
+}
+
+// ================================
+// Check Is Decrypted
+// ================================
+
+export function checkIsDecrypted(string: string | string[]) {
+  return !string?.includes('[')
+}
+
+// ================================
+// Decrypt Name
+// ================================
+
+export type DecryptNameErrorType = CheckLabelErrorType
+
+/**
+ * Decrypts a name
+ *
+ * @throws {DecryptNameErrorType}
+ * @param name - Name to decrypt
+ */
+export function decryptName(name: string) {
+  return name
+    .split('.')
+    .map((label: any) => checkLabel(label))
+    .join('.')
+}
+
+// ================================
+// Internal Utils
+// ================================
+
+function getLabels() {
+  return hasLocalStorage
+    ? JSON.parse(localStorage.getItem('ensjs:labels') as string) || {}
+    : {}
+}

package/src/utils/name/makeLabelNodeAndParent.ts

@@ -0,0 +1,27 @@
+import {
+  type LabelhashErrorType,
+  labelhash,
+  type NamehashErrorType,
+  namehash,
+} from 'viem'
+
+export type MakeLabelNodeAndParentErrorType =
+  | NamehashErrorType
+  | LabelhashErrorType
+
+/**
+ * Makes a label node and parent
+ *
+ * @throws {MakeLabelNodeAndParentErrorType}
+ * @param name - Name to make label node and parent
+ */
+export const makeLabelNodeAndParent = (name: string) => {
+  const labels = name.split('.')
+  const label = labels.shift() as string
+  const parentNode = namehash(labels.join('.'))
+  return {
+    label,
+    labelhash: labelhash(label),
+    parentNode,
+  }
+}

package/src/utils/name/normalize.ts

@@ -0,0 +1,70 @@
+import {
+  type DisallowedToken,
+  type EmojiToken,
+  ens_beautify,
+  ens_emoji,
+  ens_normalize,
+  ens_normalize_fragment,
+  ens_split,
+  ens_tokenize,
+  type IgnoredToken,
+  is_combining_mark,
+  type Label,
+  type MappedToken,
+  type NFCToken,
+  type StopToken,
+  should_escape,
+  type TextToken,
+  type Token,
+  type ValidToken,
+} from '@adraffy/ens-normalize'
+import type { ErrorType } from '../../errors/utils.js'
+
+const zeros = new Uint8Array(32)
+zeros.fill(0)
+
+// ================================
+// Normalize
+// ================================
+
+export type NormalizeErrorType = ErrorType
+
+/**
+ * Normalizes a name
+ *
+ * @throws {NormalizeErrorType}
+ * @param name - Name to normalize
+ */
+export const normalize = (name: string) => (name ? ens_normalize(name) : name)
+
+/** @deprecated use `normalize` instead */
+export const normalise = normalize
+
+// ================================
+// Extra Exports
+// ================================
+
+export const beautify = ens_beautify
+export const emoji = ens_emoji
+export const normalizeFragment = ens_normalize_fragment
+/** @deprecated use `normalizeFragment` instead */
+export const normaliseFragment = ens_normalize_fragment
+export const split = ens_split
+export const tokenize = ens_tokenize
+/** @deprecated use `tokenize` instead */
+export const tokenise = tokenize
+export const isCombiningMark = is_combining_mark
+export const shouldEscape = should_escape
+
+export type {
+  DisallowedToken,
+  EmojiToken,
+  IgnoredToken,
+  Label,
+  MappedToken,
+  NFCToken,
+  StopToken,
+  TextToken,
+  Token,
+  ValidToken,
+}