@ensdomains/ensjs 4.1.2 → 5.0.0-alpha.0

package/src/errors/utils.ts

@@ -1,5 +1,7 @@
 import { BaseError } from './base.js'
 
+export type ErrorType<name extends string = 'Error'> = Error & { name: name }
+
 export class FusesOutOfRangeError extends BaseError {
   override name = 'FusesOutOfRangeError'
 

package/src/errors/version.ts

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

package/src/exports/chain.ts

@@ -0,0 +1 @@
+export * from '../clients/chain.js'

package/src/exports/internal.ts

@@ -0,0 +1 @@
+export * from '../types/internal.js'

package/src/exports/public/v2.ts

@@ -0,0 +1,2 @@
+export * from '../../actions/public/v2/getResolverName.js'
+export * from '../../actions/public/v2/getUnderlyingResolver.js'

package/src/exports/public.ts

@@ -0,0 +1,16 @@
+export * from '../actions/public/getAbiRecord.js'
+export * from '../actions/public/getAddressRecord.js'
+export * from '../actions/public/getAvailable.js'
+export * from '../actions/public/getContentHashRecord.js'
+export * from '../actions/public/getCredentials.js'
+export * from '../actions/public/getExpiry.js'
+export * from '../actions/public/getName.js'
+export * from '../actions/public/getOwner.js'
+export * from '../actions/public/getPrice.js'
+export * from '../actions/public/getRecords.js'
+export * from '../actions/public/getResolver.js'
+export * from '../actions/public/getSupportedInterfaces.js'
+export * from '../actions/public/getTextRecord.js'
+export * from '../actions/public/getWrapperData.js'
+export * from '../actions/public/getWrapperName.js'
+export * from '../actions/public/resolveNameData.js'

package/src/exports/wallet.ts

@@ -0,0 +1,18 @@
+export * from '../actions/wallet/clearRecords.js'
+export * from '../actions/wallet/commitName.js'
+export * from '../actions/wallet/createSubname.js'
+export * from '../actions/wallet/deleteSubname.js'
+export * from '../actions/wallet/registerName.js'
+export * from '../actions/wallet/renewNames.js'
+export * from '../actions/wallet/setAbiRecord.js'
+export * from '../actions/wallet/setAddressRecord.js'
+export * from '../actions/wallet/setChildFuses.js'
+export * from '../actions/wallet/setContentHashRecord.js'
+export * from '../actions/wallet/setFuses.js'
+export * from '../actions/wallet/setPrimaryName.js'
+export * from '../actions/wallet/setRecords.js'
+export * from '../actions/wallet/setResolver.js'
+export * from '../actions/wallet/setTextRecord.js'
+export * from '../actions/wallet/transferName.js'
+export * from '../actions/wallet/unwrapName.js'
+export * from '../actions/wallet/wrapName.js'

package/src/index.ts

@@ -1,31 +1,3 @@
-export {
-  ensPublicActions,
-  type EnsPublicActions,
-} from './clients/decorators/public.js'
-export {
-  ensSubgraphActions,
-  type EnsSubgraphActions,
-} from './clients/decorators/subgraph.js'
-export {
-  ensWalletActions,
-  type EnsWalletActions,
-} from './clients/decorators/wallet.js'
-export {
-  createEnsPublicClient,
-  type EnsPublicClient,
-  type EnsPublicClientConfig,
-} from './clients/public.js'
-export {
-  createEnsSubgraphClient,
-  type EnsSubgraphClient,
-  type EnsSubgraphClientConfig,
-} from './clients/subgraph.js'
-export {
-  createEnsWalletClient,
-  type EnsWalletClient,
-  type EnsWalletClientConfig,
-} from './clients/wallet.js'
-
 export { addEnsContracts } from './contracts/addEnsContracts.js'
 export { BaseError } from './errors/base.js'
 export { NoChainError, UnsupportedChainError } from './errors/contracts.js'

package/src/subgraph.ts

@@ -1,4 +1,4 @@
-export { createSubgraphClient } from './functions/subgraph/client.js'
+export { createSubgraphClient } from './actions/subgraph/client.js'
 export type {
   AbiChanged,
   AddrChanged,
@@ -31,40 +31,59 @@ export type {
   Transfer,
   VersionChanged,
   WrappedTransfer,
-} from './functions/subgraph/events.js'
+} from './actions/subgraph/events.js'
 export {
   default as getDecodedName,
+  type GetDecodedNameErrorType,
   type GetDecodedNameParameters,
   type GetDecodedNameReturnType,
-} from './functions/subgraph/getDecodedName.js'
+} from './actions/subgraph/getDecodedName.js'
 export {
   default as getNameHistory,
+  type GetNameHistoryErrorType,
   type GetNameHistoryParameters,
   type GetNameHistoryReturnType,
-} from './functions/subgraph/getNameHistory.js'
+  type ReturnResolverEvent,
+} from './actions/subgraph/getNameHistory.js'
 export {
   default as getNamesForAddress,
+  type GetNamesForAddressErrorType,
   type GetNamesForAddressParameters,
   type GetNamesForAddressReturnType,
   type NameWithRelation,
-} from './functions/subgraph/getNamesForAddress.js'
+} from './actions/subgraph/getNamesForAddress.js'
+export {
+  type GetRecordHistoryErrorType,
+  type GetRecordHistoryParameters,
+  type GetRecordHistoryReturnType,
+  getRecordHistory,
+} from './actions/subgraph/getRecordHistory.js'
+export {
+  type GetResolvedNamesForAddressErrorType,
+  type GetResolvedNamesForAddressParameters,
+  type GetResolvedNamesForAddressReturnType,
+  getResolvedNamesForAddress,
+} from './actions/subgraph/getResolvedNamesForAddress.js'
 export {
   default as getSubgraphRecords,
+  type GetSubgraphRecordsErrorType,
   type GetSubgraphRecordsParameters,
   type GetSubgraphRecordsReturnType,
-} from './functions/subgraph/getSubgraphRecords.js'
+} from './actions/subgraph/getSubgraphRecords.js'
 export {
   default as getSubgraphRegistrant,
+  type GetSubgraphRegistrantErrorType,
   type GetSubgraphRegistrantParameters,
   type GetSubgraphRegistrantReturnType,
-} from './functions/subgraph/getSubgraphRegistrant.js'
+} from './actions/subgraph/getSubgraphRegistrant.js'
 export {
   default as getSubnames,
+  type GetSubnamesErrorType,
   type GetSubnamesParameters,
   type GetSubnamesReturnType,
-} from './functions/subgraph/getSubnames.js'
+} from './actions/subgraph/getSubnames.js'
 export {
   getChecksumAddressOrNull,
   makeNameObject,
   type Name,
-} from './functions/subgraph/utils.js'
+} from './actions/subgraph/utils.js'

package/src/types/index.ts

@@ -0,0 +1,137 @@
+import type {
+  Abi,
+  Account,
+  Chain,
+  Client,
+  TransactionRequest,
+  WriteContractParameters,
+} from 'viem'
+
+export type Prettify<type> = {
+  [key in keyof type]: type[key]
+} & {}
+
+type AssignI<type, union> = {
+  [key in keyof type as key extends keyof union
+    ? union[key] extends void
+      ? never
+      : key
+    : key]: key extends keyof union ? union[key] : type[key]
+}
+
+export type Assign<type, union> = AssignI<type, union> & union
+
+export type SimpleTransactionRequest = {
+  [P in keyof Pick<TransactionRequest, 'to' | 'data'>]-?: Exclude<
+    TransactionRequest[P],
+    null
+  >
+}
+
+export type Extended = { [K in keyof Client]?: undefined } & {
+  [key: string]: unknown
+}
+
+type AllowedWriteParameters =
+  | 'gas'
+  | 'gasPrice'
+  | 'maxFeePerGas'
+  | 'maxPriorityFeePerGas'
+  | 'nonce'
+  | 'account'
+  | 'chain'
+
+export type BasicWriteContractParameters<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
+> = WriteContractParameters<
+  Abi,
+  string,
+  readonly unknown[],
+  chain,
+  account,
+  chainOverride
+>
+export type WriteTransactionParameters<
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
+> = Pick<
+  BasicWriteContractParameters<chain, account, chainOverride>,
+  AllowedWriteParameters
+>
+
+export type DecodedAbi = {
+  contentType: 1 | 2 | 4 | 8 | number
+  decoded: boolean
+  abi: string | object
+}
+
+export type DecodedAddr = {
+  coinType: number
+  symbol: string
+  value: string
+}
+
+export type DecodedText = {
+  key: string
+  value: string
+}
+
+export type AnyDate = string | number | bigint | Date
+
+export type RootName = ''
+export type TldName = `${string}`
+export type EthTldName = `eth`
+export type Eth2ldName = `${string}.eth`
+export type EthAnyName = EthTldName | Eth2ldName
+export type EthSubname = `${string}.${string}.eth`
+export type Other2ldName = `${string}.${string}`
+export type OtherSubname = `${string}.${string}.${string}`
+
+export type NameOption =
+  | TldName
+  | Eth2ldName
+  | EthSubname
+  | Other2ldName
+  | OtherSubname
+
+export type TldNameSpecifier = 'tld'
+export type Eth2ldNameSpecifier = 'eth-2ld'
+export type EthSubnameSpecifier = 'eth-subname'
+export type Other2ldNameSpecifier = 'other-2ld'
+export type OtherSubnameSpecifier = 'other-subname'
+export type RootNameSpecifier = 'root'
+export type EthTldNameSpecifier = 'eth-tld'
+
+export type NameType =
+  | TldNameSpecifier
+  | Eth2ldNameSpecifier
+  | EthSubnameSpecifier
+  | Other2ldNameSpecifier
+  | OtherSubnameSpecifier
+  | RootNameSpecifier
+  | EthTldNameSpecifier
+
+type GetEthNameType<name extends EthAnyName> = name extends EthTldName
+  ? EthTldNameSpecifier
+  : name extends EthSubname
+    ? EthSubnameSpecifier
+    : Eth2ldNameSpecifier
+type GetOtherNameType<name extends TldName> = name extends OtherSubname
+  ? OtherSubnameSpecifier
+  : name extends Other2ldName
+    ? Other2ldNameSpecifier
+    : TldNameSpecifier
+
+export type GetNameType<name extends string> = name extends RootName
+  ? RootNameSpecifier
+  : name extends EthAnyName
+    ? GetEthNameType<name>
+    : GetOtherNameType<name>
+
+export type DateWithValue<T> = {
+  date: Date
+  value: T
+}

package/src/types/internal.ts

@@ -0,0 +1,62 @@
+// ================================
+// Helper types for making custom typescript errors
+// ================================
+
+const _errorSymbol = Symbol()
+
+export type TypeError<TMessage extends string> = TMessage & {
+  _: typeof _errorSymbol
+}
+
+// Helper type to remove TypeErrors from unions
+/**
+ * Remove TypeErrors from a union to allow the actual type to be used.
+ */
+export type ExcludeTE<T> = Exclude<T, TypeError<string>>
+
+/**
+ * Type assertion helper that removes TypeErrors from a union type.
+ * This is a no-op function that only exists to help TypeScript's type system.
+ * Use this when ExcludeTE type helper alone isn't sufficient to narrow the type.
+ */
+export function ASSERT_NO_TYPE_ERROR<T>(_: T): asserts _ is ExcludeTE<T> {}
+
+/**
+ * Type assertion helper that removes TypeErrors from a union type.
+ * This is a unit function that returns it's input and only exists to help TypeScript's type system.
+ */
+export function EXCLUDE_TYPE_ERROR<T>(_: T): ExcludeTE<T> {
+  return _ as ExcludeTE<T>
+}
+
+// ================================
+// String type manipulation
+// ================================
+
+export declare type UnionToIntersection<U> = (
+  U extends any
+    ? (k: U) => void
+    : never
+) extends (k: infer I) => void
+  ? I
+  : never
+
+export type UnionToOvlds<U> = UnionToIntersection<
+  U extends any ? (f: U) => void : never
+>
+export type PopUnion<U> = UnionToOvlds<U> extends (a: infer A) => void
+  ? A
+  : never
+
+export type StringConcatenationOrder<
+  S extends string,
+  SEPARATOR extends string,
+> = PopUnion<S> extends infer SELF
+  ? //
+    SELF extends string
+    ? Exclude<S, SELF> extends never
+      ? `${SELF}`
+      : // This works because the values of S are always interpreted in ascending lexiographical order
+        `${StringConcatenationOrder<Exclude<S, SELF>, SEPARATOR>}${SEPARATOR}${SELF}`
+    : never
+  : never

package/src/utils/ccipBatchRequest.ts

@@ -1,12 +1,13 @@
 import {
   type Address,
   BaseError,
-  type Hex,
-  HttpRequestError,
   ccipRequest,
   encodeErrorResult,
+  type Hex,
+  HttpRequestError,
   parseAbi,
 } from 'viem'
+import type { ErrorType } from '../errors/utils.js'
 
 type ReadonlyDeep<T> = {
   readonly [P in keyof T]: ReadonlyDeep<T[P]>
@@ -16,6 +17,10 @@ const errorAbi = parseAbi(['error HttpError((uint16, string)[])'])
 
 type CcipRequestItem = [success: boolean, result: Hex]
 
+// ================================
+// Ccip request item handler
+// ================================
+
 const ccipRequestItemHandler = async ([
   wrappedSender,
   wrappedUrls,
@@ -50,6 +55,13 @@ const ccipRequestItemHandler = async ([
   }
 }
 
+// ================================
+// Ccip batch request
+// ================================
+
+// Could possibly be error free, but not sure
+export type CcipBatchRequestErrorType = ErrorType
+
 export const ccipBatchRequest = async (
   callDatas: ReadonlyDeep<[Address, string[], Hex][]>,
 ) => {

package/src/utils/ccipRequest.ts

@@ -1,14 +1,22 @@
 import {
   type CcipRequestParameters,
   type Chain,
+  type DecodeFunctionDataErrorType,
   decodeFunctionData,
+  type EncodeFunctionResultErrorType,
   encodeFunctionResult,
+  type GetChainContractAddressErrorType,
+  type IsAddressEqualErrorType,
   isAddressEqual,
   parseAbi,
+  type CcipRequestErrorType as viem_CcipRequestErrorType,
   ccipRequest as viemCcipRequest,
 } from 'viem'
-import { getChainContractAddress } from '../contracts/getChainContractAddress.js'
-import { ccipBatchRequest } from './ccipBatchRequest.js'
+import { getChainContractAddress } from '../clients/chain.js'
+import {
+  type CcipBatchRequestErrorType,
+  ccipBatchRequest,
+} from './ccipBatchRequest.js'
 
 const abi = parseAbi([
   'function query((address,string[],bytes)[]) returns (bool[],bytes[])',
@@ -16,6 +24,18 @@ const abi = parseAbi([
 
 const universalResolverQuerySig = '0xa780bab6'
 
+// ================================
+// Ccip request
+// ================================
+
+export type CcipRequestErrorType =
+  | GetChainContractAddressErrorType
+  | IsAddressEqualErrorType
+  | DecodeFunctionDataErrorType
+  | CcipBatchRequestErrorType
+  | EncodeFunctionResultErrorType
+  | viem_CcipRequestErrorType
+
 export const ccipRequest =
   <TChain extends Chain>(chain: TChain) =>
   async ({
@@ -23,8 +43,9 @@ export const ccipRequest =
     sender,
     urls,
   }: CcipRequestParameters): ReturnType<typeof viemCcipRequest> => {
+    // TODO: Improve
     const universalResolverAddress = getChainContractAddress({
-      client: { chain },
+      chain,
       contract: 'ensUniversalResolver',
     })
     const isUniversalResolverRequest = isAddressEqual(

package/src/utils/clientWithOverrides.ts

@@ -0,0 +1,27 @@
+import type { Account, Address, Chain, Client, Transport } from 'viem'
+import { type ParseAccountErrorType, parseAccount } from 'viem/utils'
+
+// ================================
+// Client with overrides
+// ================================
+
+export type ClientWithOverridesErrorType = ParseAccountErrorType
+
+export const clientWithOverrides = <
+  chain extends Chain | undefined,
+  account extends Account | undefined,
+>(
+  client: Client<Transport, chain, account>,
+  overrides: {
+    account?: unknown
+    chain?: unknown
+  },
+) => {
+  return {
+    ...client,
+    account: parseAccount(
+      (overrides.account as Account | Address | undefined) || client.account!,
+    ),
+    chain: overrides.chain || client.chain,
+  } as Client<Transport, NonNullable<chain>, NonNullable<account>>
+}

package/src/utils/coders/clearRecords.ts

@@ -0,0 +1,33 @@
+import type { EncodeFunctionDataParameters, Hex } from 'viem'
+import {
+  publicResolverClearRecordsSnippet,
+  publicResolverClearRecordsV2Snippet,
+} from '../../contracts/publicResolver.js'
+
+// ================================
+// Clear records parameters
+// ================================
+
+export type ClearRecordsParametersErrorType = never
+
+export const clearRecordsParameters = (namehash: Hex) =>
+  ({
+    abi: publicResolverClearRecordsSnippet,
+    functionName: 'clearRecords',
+    args: [namehash],
+  }) as const satisfies EncodeFunctionDataParameters<
+    typeof publicResolverClearRecordsSnippet
+  >
+
+export const clearRecordsParametersV2 = () =>
+  ({
+    abi: publicResolverClearRecordsV2Snippet,
+    functionName: 'clearRecords',
+    args: [],
+  }) as const satisfies EncodeFunctionDataParameters<
+    typeof publicResolverClearRecordsV2Snippet
+  >
+
+export type ClearRecordsParametersReturnType = ReturnType<
+  typeof clearRecordsParameters
+>

package/src/utils/coders/encodeAbi.ts

@@ -0,0 +1,144 @@
+import {
+  type BytesToHexErrorType,
+  bytesToHex,
+  type Hex,
+  type StringToHexErrorType,
+  stringToHex,
+} from 'viem'
+import { type ErrorType, UnknownContentTypeError } from '../../errors/utils.js'
+import type { Prettify } from '../../types/index.js'
+
+export type AbiEncodeAs = 'json' | 'zlib' | 'cbor' | 'uri'
+
+type AbiContentType = 1 | 2 | 4 | 8
+
+const abiEncodeMap = {
+  json: 1,
+  zlib: 2,
+  cbor: 4,
+  uri: 8,
+} as const
+type AbiEncodeMap = typeof abiEncodeMap
+
+type GetAbiContentType<encodeAs extends AbiEncodeAs> = AbiEncodeMap[encodeAs]
+
+export type EncodeAbiParameters<encodeAs extends AbiEncodeAs = AbiEncodeAs> =
+  encodeAs extends 'uri'
+    ? {
+        encodeAs: encodeAs
+        data: string | null
+      }
+    : {
+        encodeAs: encodeAs
+        data: Record<any, any> | null
+      }
+
+export type EncodedAbi<contentType extends AbiContentType = AbiContentType> = {
+  contentType: contentType
+  encodedData: Hex
+}
+
+export type EncodeAbiReturnType<contentType extends AbiContentType> =
+  EncodedAbi<contentType>
+
+// ================================
+// Content Type To Encode As
+// ================================
+
+export type ContentTypeToEncodeAsErrorType = UnknownContentTypeError
+
+/**
+ * Converts a content type to an encode as
+ *
+ * @throws {ContentTypeToEncodeAsErrorType}
+ * @param contentType - The content type to convert
+ */
+export const contentTypeToEncodeAs = (
+  contentType: AbiContentType,
+): AbiEncodeAs => {
+  switch (contentType) {
+    case 1:
+      return 'json'
+    case 2:
+      return 'zlib'
+    case 4:
+      return 'cbor'
+    case 8:
+      return 'uri'
+    default:
+      throw new UnknownContentTypeError({ contentType })
+  }
+}
+
+// ================================
+// Encode As To Content Type
+// ================================
+
+export type EncodeAsToContentTypeErrorType = UnknownContentTypeError
+
+export const encodeAsToContentType = (
+  encodeAs: AbiEncodeAs,
+): AbiContentType => {
+  const contentType = abiEncodeMap[encodeAs]
+  if (contentType === undefined) {
+    throw new UnknownContentTypeError({ contentType: encodeAs })
+  }
+  return contentType
+}
+
+// ================================
+// Encode Abi
+// ================================
+
+export type EncodeAbiErrorType =
+  | UnknownContentTypeError
+  | StringToHexErrorType
+  | BytesToHexErrorType
+  | ErrorType
+
+export const encodeAbi = async <
+  encodeAs extends AbiEncodeAs,
+  contentType extends GetAbiContentType<encodeAs>,
+>({
+  encodeAs,
+  data,
+}: EncodeAbiParameters<encodeAs>): Promise<
+  Prettify<EncodeAbiReturnType<contentType>>
+> => {
+  let contentType: AbiContentType
+  let encodedData: Hex = '0x'
+  switch (encodeAs) {
+    case 'json':
+      contentType = 1
+      // may throw StringToHexErrorType
+      if (data) encodedData = stringToHex(JSON.stringify(data))
+      break
+    case 'zlib': {
+      contentType = 2
+      if (data) {
+        const { deflate } = await import('pako/dist/pako_deflate.min.js')
+        // may throw BytesToHexErrorType
+        encodedData = bytesToHex(deflate(JSON.stringify(data)))
+      }
+      break
+    }
+    case 'cbor': {
+      contentType = 4
+      if (data) {
+        const { cborEncode } = await import('@ensdomains/address-encoder/utils')
+        // may throw BytesToHexErrorType
+        encodedData = bytesToHex(new Uint8Array(cborEncode(data)))
+      }
+      break
+    }
+    default: {
+      contentType = 8
+      if (data) {
+        // may throw StringToHexErrorType
+        encodedData = stringToHex(data as string)
+      }
+      break
+    }
+  }
+  return { contentType: contentType as contentType, encodedData }
+}