@ensdomains/ensjs-query-core 0.0.1

package/src/query/public/getTextRecord.ts

@@ -0,0 +1,62 @@
+import {
+  ASSERT_NO_TYPE_ERROR,
+  type ExcludeTE,
+} from '@ensdomains/ensjs/internal'
+import type { QueryOptions } from '@tanstack/query-core'
+import type { Config } from '@wagmi/core'
+import type {
+  Compute,
+  ExactPartial,
+  ScopeKeyParameter,
+} from '@wagmi/core/internal'
+import type { Chain } from 'viem'
+import {
+  type GetTextRecordErrorType,
+  type GetTextRecordParameters,
+  type GetTextRecordReturnType,
+  getTextRecord,
+} from '../../actions/public/getTextRecord.js'
+import type { RequireConfigContracts } from '../../utils/chain.js'
+import { filterQueryOptions } from '../utils.js'
+
+export type GetTextRecordOptions<config extends Config> = Compute<
+  ExactPartial<GetTextRecordParameters<config>> & ScopeKeyParameter
+>
+
+export function getTextRecordQueryOptions<
+  chains extends readonly [Chain, ...Chain[]],
+>(
+  config: RequireConfigContracts<chains, 'ensUniversalResolver'>,
+  options: GetTextRecordOptions<ExcludeTE<typeof config>> = {},
+) {
+  ASSERT_NO_TYPE_ERROR(config)
+
+  return {
+    async queryFn({ queryKey }) {
+      const { name, key, scopeKey: _, ...parameters } = queryKey[1]
+      if (!name) throw new Error('name is required')
+      if (!key) throw new Error('key is required')
+      return getTextRecord<chains>(config, { ...parameters, name, key })
+    },
+    queryKey: getTextRecordQueryKey(options),
+  } as const satisfies QueryOptions<
+    GetTextRecordQueryFnData,
+    GetTextRecordErrorType,
+    GetTextRecordData,
+    GetTextRecordQueryKey<typeof config>
+  >
+}
+
+export type GetTextRecordQueryFnData = GetTextRecordReturnType
+
+export type GetTextRecordData = GetTextRecordQueryFnData
+
+export function getTextRecordQueryKey<config extends Config>(
+  options: GetTextRecordOptions<config> = {},
+) {
+  return ['ensjs_textRecord', filterQueryOptions(options)] as const
+}
+
+export type GetTextRecordQueryKey<config extends Config> = ReturnType<
+  typeof getTextRecordQueryKey<config>
+>

package/src/query/public/getWrapperData.ts

@@ -0,0 +1,61 @@
+import {
+  ASSERT_NO_TYPE_ERROR,
+  type ExcludeTE,
+} from '@ensdomains/ensjs/internal'
+import type { QueryOptions } from '@tanstack/query-core'
+import type { Config } from '@wagmi/core'
+import type {
+  Compute,
+  ExactPartial,
+  ScopeKeyParameter,
+} from '@wagmi/core/internal'
+import type { Chain } from 'viem'
+import {
+  type GetWrapperDataErrorType,
+  type GetWrapperDataParameters,
+  type GetWrapperDataReturnType,
+  getWrapperData,
+} from '../../actions/public/getWrapperData.js'
+import type { RequireConfigContracts } from '../../utils/chain.js'
+import { filterQueryOptions } from '../utils.js'
+
+export type GetWrapperDataOptions<config extends Config> = Compute<
+  ExactPartial<GetWrapperDataParameters<config>> & ScopeKeyParameter
+>
+
+export function getWrapperDataQueryOptions<
+  chains extends readonly [Chain, ...Chain[]],
+>(
+  config: RequireConfigContracts<chains, 'ensNameWrapper' | 'multicall3'>,
+  options: GetWrapperDataOptions<ExcludeTE<typeof config>> = {},
+) {
+  ASSERT_NO_TYPE_ERROR(config)
+
+  return {
+    async queryFn({ queryKey }) {
+      const { name, scopeKey: _, ...parameters } = queryKey[1]
+      if (!name) throw new Error('name is required')
+      return getWrapperData<chains>(config, { ...parameters, name })
+    },
+    queryKey: getWrapperDataQueryKey(options),
+  } as const satisfies QueryOptions<
+    GetWrapperDataQueryFnData,
+    GetWrapperDataErrorType,
+    GetWrapperDataData,
+    GetWrapperDataQueryKey<typeof config>
+  >
+}
+
+export type GetWrapperDataQueryFnData = GetWrapperDataReturnType
+
+export type GetWrapperDataData = GetWrapperDataQueryFnData
+
+export function getWrapperDataQueryKey<config extends Config>(
+  options: GetWrapperDataOptions<config> = {},
+) {
+  return ['ensjs_wrapperData', filterQueryOptions(options)] as const
+}
+
+export type GetWrapperDataQueryKey<config extends Config> = ReturnType<
+  typeof getWrapperDataQueryKey<config>
+>

package/src/query/public/getWrapperName.ts

@@ -0,0 +1,61 @@
+import {
+  ASSERT_NO_TYPE_ERROR,
+  type ExcludeTE,
+} from '@ensdomains/ensjs/internal'
+import type { QueryOptions } from '@tanstack/query-core'
+import type { Config } from '@wagmi/core'
+import type {
+  Compute,
+  ExactPartial,
+  ScopeKeyParameter,
+} from '@wagmi/core/internal'
+import type { Chain } from 'viem'
+import {
+  type GetWrapperNameErrorType,
+  type GetWrapperNameParameters,
+  type GetWrapperNameReturnType,
+  getWrapperName,
+} from '../../actions/public/getWrapperName.js'
+import type { RequireConfigContracts } from '../../utils/chain.js'
+import { filterQueryOptions } from '../utils.js'
+
+export type GetWrapperNameOptions<config extends Config> = Compute<
+  ExactPartial<GetWrapperNameParameters<config>> & ScopeKeyParameter
+>
+
+export function getWrapperNameQueryOptions<
+  chains extends readonly [Chain, ...Chain[]],
+>(
+  config: RequireConfigContracts<chains, 'ensNameWrapper'>,
+  options: GetWrapperNameOptions<ExcludeTE<typeof config>> = {},
+) {
+  ASSERT_NO_TYPE_ERROR(config)
+
+  return {
+    async queryFn({ queryKey }) {
+      const { name, scopeKey: _, ...parameters } = queryKey[1]
+      if (!name) throw new Error('name is required')
+      return getWrapperName<chains>(config, { ...parameters, name })
+    },
+    queryKey: getWrapperNameQueryKey(options),
+  } as const satisfies QueryOptions<
+    GetWrapperNameQueryFnData,
+    GetWrapperNameErrorType,
+    GetWrapperNameData,
+    GetWrapperNameQueryKey<typeof config>
+  >
+}
+
+export type GetWrapperNameQueryFnData = GetWrapperNameReturnType
+
+export type GetWrapperNameData = GetWrapperNameQueryFnData
+
+export function getWrapperNameQueryKey<config extends Config>(
+  options: GetWrapperNameOptions<config> = {},
+) {
+  return ['ensjs_wrapperName', filterQueryOptions(options)] as const
+}
+
+export type GetWrapperNameQueryKey<config extends Config> = ReturnType<
+  typeof getWrapperNameQueryKey<config>
+>

package/src/query/public/index.ts

@@ -0,0 +1,134 @@
+export {
+  type GetAbiRecordData,
+  type GetAbiRecordOptions,
+  type GetAbiRecordQueryFnData,
+  type GetAbiRecordQueryKey,
+  getAbiRecordQueryKey,
+  getAbiRecordQueryOptions,
+} from './getAbiRecord.js'
+
+export {
+  type GetAddressRecordData,
+  type GetAddressRecordOptions,
+  type GetAddressRecordQueryFnData,
+  type GetAddressRecordQueryKey,
+  getAddressRecordQueryKey,
+  getAddressRecordQueryOptions,
+} from './getAddressRecord.js'
+
+export {
+  type GetAvailableData,
+  type GetAvailableOptions,
+  type GetAvailableQueryFnData,
+  type GetAvailableQueryKey,
+  getAvailableQueryKey,
+  getAvailableQueryOptions,
+} from './getAvailable.js'
+
+export {
+  type GetContentHashRecordData,
+  type GetContentHashRecordOptions,
+  type GetContentHashRecordQueryFnData,
+  type GetContentHashRecordQueryKey,
+  getContentHashRecordQueryKey,
+  getContentHashRecordQueryOptions,
+} from './getContentHashRecord.js'
+
+export {
+  type GetCredentialsData,
+  type GetCredentialsOptions,
+  type GetCredentialsQueryFnData,
+  type GetCredentialsQueryKey,
+  getCredentialsQueryKey,
+  getCredentialsQueryOptions,
+} from './getCredentials.js'
+
+export {
+  type GetExpiryData,
+  type GetExpiryOptions,
+  type GetExpiryQueryFnData,
+  type GetExpiryQueryKey,
+  getExpiryQueryKey,
+  getExpiryQueryOptions,
+} from './getExpiry.js'
+
+export {
+  type GetNameData,
+  type GetNameOptions,
+  type GetNameQueryFnData,
+  type GetNameQueryKey,
+  getNameQueryKey,
+  getNameQueryOptions,
+} from './getName.js'
+
+export {
+  type GetOwnerData,
+  type GetOwnerOptions,
+  type GetOwnerQueryFnData,
+  type GetOwnerQueryKey,
+  getOwnerQueryKey,
+  getOwnerQueryOptions,
+} from './getOwner.js'
+
+export {
+  type GetPriceData,
+  type GetPriceOptions,
+  type GetPriceQueryFnData,
+  type GetPriceQueryKey,
+  getPriceQueryKey,
+  getPriceQueryOptions,
+} from './getPrice.js'
+
+export {
+  type GetRecordsData,
+  type GetRecordsOptions,
+  type GetRecordsQueryFnData,
+  type GetRecordsQueryKey,
+  getRecordsQueryKey,
+  getRecordsQueryOptions,
+} from './getRecords.js'
+
+export {
+  type GetResolverData,
+  type GetResolverOptions,
+  type GetResolverQueryFnData,
+  type GetResolverQueryKey,
+  getResolverQueryKey,
+  getResolverQueryOptions,
+} from './getResolver.js'
+
+export {
+  type GetSupportedInterfacesData,
+  type GetSupportedInterfacesOptions,
+  type GetSupportedInterfacesQueryFnData,
+  type GetSupportedInterfacesQueryKey,
+  getSupportedInterfacesQueryKey,
+  getSupportedInterfacesQueryOptions,
+} from './getSupportedInterfaces.js'
+
+export {
+  type GetTextRecordData,
+  type GetTextRecordOptions,
+  type GetTextRecordQueryFnData,
+  type GetTextRecordQueryKey,
+  getTextRecordQueryKey,
+  getTextRecordQueryOptions,
+} from './getTextRecord.js'
+
+export {
+  type GetWrapperDataData,
+  type GetWrapperDataOptions,
+  type GetWrapperDataQueryFnData,
+  type GetWrapperDataQueryKey,
+  getWrapperDataQueryKey,
+  getWrapperDataQueryOptions,
+} from './getWrapperData.js'
+
+export {
+  type GetWrapperNameData,
+  type GetWrapperNameOptions,
+  type GetWrapperNameQueryFnData,
+  type GetWrapperNameQueryKey,
+  getWrapperNameQueryKey,
+  getWrapperNameQueryOptions,
+} from './getWrapperName.js'

package/src/query/utils.ts

@@ -0,0 +1,26 @@
+/* biome-ignore-all lint/correctness/noUnusedVariables: just for destructuring */
+
+export function filterQueryOptions<type extends Record<string, unknown>>(
+  options: type,
+): type {
+  // destructuring is super fast
+  // biome-ignore format: no formatting
+  const {
+      // import('@tanstack/query-core').QueryOptions
+      _defaulted, behavior, gcTime, initialData, initialDataUpdatedAt, maxPages, meta, networkMode, queryFn, queryHash, queryKey, queryKeyHashFn, retry, retryDelay, structuralSharing,
+  
+      // import('@tanstack/query-core').InfiniteQueryObserverOptions
+      getPreviousPageParam, getNextPageParam, initialPageParam,
+  
+      // import('@tanstack/react-query').UseQueryOptions
+      _optimisticResults, enabled, notifyOnChangeProps, placeholderData, refetchInterval, refetchIntervalInBackground, refetchOnMount, refetchOnReconnect, refetchOnWindowFocus, retryOnMount, select, staleTime, suspense, throwOnError,
+  
+      ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+      // wagmi
+      ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+      config, connector, query,
+      ...rest
+    } = options
+
+  return rest as type
+}

package/src/query/wallet/clearRecords.ts

@@ -0,0 +1,54 @@
+import {
+  ASSERT_NO_TYPE_ERROR,
+  type ExcludeTE,
+} from '@ensdomains/ensjs/internal'
+import type { MutationOptions } from '@tanstack/query-core'
+import type { Config } from '@wagmi/core'
+import type {
+  Compute,
+  ExactPartial,
+  ScopeKeyParameter,
+} from '@wagmi/core/internal'
+import type { Chain } from 'viem'
+import {
+  type ClearRecordsErrorType,
+  type ClearRecordsParameters,
+  type ClearRecordsReturnType,
+  clearRecords,
+} from '../../actions/wallet/clearRecords.js'
+import type { RequireConfigContracts } from '../../utils/chain.js'
+import { filterQueryOptions } from '../utils.js'
+
+export type ClearRecordsOptions<config extends Config> = Compute<
+  ExactPartial<ClearRecordsParameters<config>> & ScopeKeyParameter
+>
+
+export function clearRecordsMutationOptions<
+  chains extends readonly [Chain, ...Chain[]],
+>(
+  config: RequireConfigContracts<chains, 'ensUniversalResolver'>,
+  options: ClearRecordsOptions<ExcludeTE<typeof config>>,
+) {
+  ASSERT_NO_TYPE_ERROR(config)
+
+  return {
+    mutationFn: async (variables: ClearRecordsParameters<typeof config>) => {
+      return clearRecords(config, variables)
+    },
+    mutationKey: clearRecordsMutationKey(options),
+  } as const satisfies MutationOptions<
+    ClearRecordsReturnType,
+    ClearRecordsErrorType,
+    ClearRecordsParameters<typeof config>
+  >
+}
+
+export function clearRecordsMutationKey<config extends Config>(
+  options: ClearRecordsOptions<config>,
+) {
+  return ['ensjs_clearRecords', filterQueryOptions(options)] as const
+}
+
+export type ClearRecordsMutationKey<config extends Config> = ReturnType<
+  typeof clearRecordsMutationKey<config>
+>

package/src/query/wallet/commitName.ts

@@ -0,0 +1,54 @@
+import {
+  ASSERT_NO_TYPE_ERROR,
+  type ExcludeTE,
+} from '@ensdomains/ensjs/internal'
+import type { MutationOptions } from '@tanstack/query-core'
+import type { Config } from '@wagmi/core'
+import type {
+  Compute,
+  ExactPartial,
+  ScopeKeyParameter,
+} from '@wagmi/core/internal'
+import type { Chain } from 'viem'
+import {
+  type CommitNameErrorType,
+  type CommitNameParameters,
+  type CommitNameReturnType,
+  commitName,
+} from '../../actions/wallet/commitName.js'
+import type { RequireConfigContracts } from '../../utils/chain.js'
+import { filterQueryOptions } from '../utils.js'
+
+export type CommitNameOptions<config extends Config> = Compute<
+  ExactPartial<CommitNameParameters<config>> & ScopeKeyParameter
+>
+
+export function commitNameMutationOptions<
+  chains extends readonly [Chain, ...Chain[]],
+>(
+  config: RequireConfigContracts<chains, 'ensEthRegistrarController'>,
+  options: CommitNameOptions<ExcludeTE<typeof config>>,
+) {
+  ASSERT_NO_TYPE_ERROR(config)
+
+  return {
+    mutationFn: async (variables: CommitNameParameters<typeof config>) => {
+      return commitName(config, variables)
+    },
+    mutationKey: commitNameMutationKey(options),
+  } as const satisfies MutationOptions<
+    CommitNameReturnType,
+    CommitNameErrorType,
+    CommitNameParameters<typeof config>
+  >
+}
+
+export function commitNameMutationKey<config extends Config>(
+  options: CommitNameOptions<config>,
+) {
+  return ['ensjs_commitName', filterQueryOptions(options)] as const
+}
+
+export type CommitNameMutationKey<config extends Config> = ReturnType<
+  typeof commitNameMutationKey<config>
+>

package/src/query/wallet/createSubname.ts

@@ -0,0 +1,57 @@
+import {
+  ASSERT_NO_TYPE_ERROR,
+  type ExcludeTE,
+} from '@ensdomains/ensjs/internal'
+import type { MutationOptions } from '@tanstack/query-core'
+import type { Config } from '@wagmi/core'
+import type {
+  Compute,
+  ExactPartial,
+  ScopeKeyParameter,
+} from '@wagmi/core/internal'
+import type { Chain } from 'viem'
+import {
+  type CreateSubnameErrorType,
+  type CreateSubnameParameters,
+  type CreateSubnameReturnType,
+  createSubname,
+} from '../../actions/wallet/createSubname.js'
+import type { RequireConfigContracts } from '../../utils/chain.js'
+import { filterQueryOptions } from '../utils.js'
+
+export type CreateSubnameOptions<config extends Config> = Compute<
+  ExactPartial<CreateSubnameParameters<config>> & ScopeKeyParameter
+>
+
+export function createSubnameMutationOptions<
+  chains extends readonly [Chain, ...Chain[]],
+>(
+  config: RequireConfigContracts<
+    chains,
+    'ensNameWrapper' | 'ensPublicResolver'
+  >,
+  options: CreateSubnameOptions<ExcludeTE<typeof config>>,
+) {
+  ASSERT_NO_TYPE_ERROR(config)
+
+  return {
+    mutationFn: async (variables: CreateSubnameParameters<typeof config>) => {
+      return createSubname(config, variables)
+    },
+    mutationKey: createSubnameMutationKey(options),
+  } as const satisfies MutationOptions<
+    CreateSubnameReturnType,
+    CreateSubnameErrorType,
+    CreateSubnameParameters<typeof config>
+  >
+}
+
+export function createSubnameMutationKey<config extends Config>(
+  options: CreateSubnameOptions<config>,
+) {
+  return ['ensjs_createSubname', filterQueryOptions(options)] as const
+}
+
+export type CreateSubnameMutationKey<config extends Config> = ReturnType<
+  typeof createSubnameMutationKey<config>
+>

package/src/query/wallet/deleteSubname.ts

@@ -0,0 +1,54 @@
+import {
+  ASSERT_NO_TYPE_ERROR,
+  type ExcludeTE,
+} from '@ensdomains/ensjs/internal'
+import type { MutationOptions } from '@tanstack/query-core'
+import type { Config } from '@wagmi/core'
+import type {
+  Compute,
+  ExactPartial,
+  ScopeKeyParameter,
+} from '@wagmi/core/internal'
+import type { Chain } from 'viem'
+import {
+  type DeleteSubnameErrorType,
+  type DeleteSubnameParameters,
+  type DeleteSubnameReturnType,
+  deleteSubname,
+} from '../../actions/wallet/deleteSubname.js'
+import type { RequireConfigContracts } from '../../utils/chain.js'
+import { filterQueryOptions } from '../utils.js'
+
+export type DeleteSubnameOptions<config extends Config> = Compute<
+  ExactPartial<DeleteSubnameParameters<config>> & ScopeKeyParameter
+>
+
+export function deleteSubnameMutationOptions<
+  chains extends readonly [Chain, ...Chain[]],
+>(
+  config: RequireConfigContracts<chains, 'ensRegistry' | 'ensNameWrapper'>,
+  options: DeleteSubnameOptions<ExcludeTE<typeof config>>,
+) {
+  ASSERT_NO_TYPE_ERROR(config)
+
+  return {
+    mutationFn: async (variables: DeleteSubnameParameters<typeof config>) => {
+      return deleteSubname(config, variables)
+    },
+    mutationKey: deleteSubnameMutationKey(options),
+  } as const satisfies MutationOptions<
+    DeleteSubnameReturnType,
+    DeleteSubnameErrorType,
+    DeleteSubnameParameters<typeof config>
+  >
+}
+
+export function deleteSubnameMutationKey<config extends Config>(
+  options: DeleteSubnameOptions<config>,
+) {
+  return ['ensjs_deleteSubname', filterQueryOptions(options)] as const
+}
+
+export type DeleteSubnameMutationKey<config extends Config> = ReturnType<
+  typeof deleteSubnameMutationKey<config>
+>

package/src/query/wallet/index.ts

@@ -0,0 +1,85 @@
+export {
+  type ClearRecordsMutationKey,
+  type ClearRecordsOptions,
+  clearRecordsMutationKey,
+  clearRecordsMutationOptions,
+} from './clearRecords.js'
+export {
+  type CommitNameMutationKey,
+  type CommitNameOptions,
+  commitNameMutationKey,
+  commitNameMutationOptions,
+} from './commitName.js'
+export {
+  type CreateSubnameMutationKey,
+  type CreateSubnameOptions,
+  createSubnameMutationKey,
+  createSubnameMutationOptions,
+} from './createSubname.js'
+export {
+  type DeleteSubnameMutationKey,
+  type DeleteSubnameOptions,
+  deleteSubnameMutationKey,
+  deleteSubnameMutationOptions,
+} from './deleteSubname.js'
+export {
+  type RegisterNameMutationKey,
+  type RegisterNameOptions,
+  registerNameMutationKey,
+  registerNameMutationOptions,
+} from './registerName.js'
+export {
+  type RenewNamesMutationKey,
+  type RenewNamesOptions,
+  renewNamesMutationKey,
+  renewNamesMutationOptions,
+} from './renewNames.js'
+export {
+  type SetAbiRecordMutationKey,
+  type SetAbiRecordOptions,
+  setAbiRecordMutationKey,
+  setAbiRecordMutationOptions,
+} from './setAbiRecord.js'
+export {
+  type SetAddressRecordMutationKey,
+  type SetAddressRecordOptions,
+  setAddressRecordMutationKey,
+  setAddressRecordMutationOptions,
+} from './setAddressRecord.js'
+export {
+  type SetContentHashRecordMutationKey,
+  type SetContentHashRecordOptions,
+  setContentHashRecordMutationKey,
+  setContentHashRecordMutationOptions,
+} from './setContentHashRecord.js'
+export {
+  type SetPrimaryNameMutationKey,
+  type SetPrimaryNameOptions,
+  setPrimaryNameMutationKey,
+  setPrimaryNameMutationOptions,
+} from './setPrimaryName.js'
+export {
+  type SetRecordsMutationKey,
+  type SetRecordsOptions,
+  setRecordsMutationKey,
+  setRecordsMutationOptions,
+} from './setRecords.js'
+export {
+  type SetResolverMutationKey,
+  type SetResolverOptions,
+  setResolverMutationKey,
+  setResolverMutationOptions,
+} from './setResolver.js'
+export {
+  type SetTextRecordMutationKey,
+  type SetTextRecordOptions,
+  setTextRecordMutationKey,
+  setTextRecordMutationOptions,
+} from './setTextRecord.js'
+
+export {
+  type TransferNameMutationKey,
+  type TransferNameOptions,
+  transferNameMutationKey,
+  transferNameMutationOptions,
+} from './transferName.js'