@wagmi/core/src/query/verifyMessage.ts

VanillaJS library for Ethereum

import type { QueryOptions } from '@tanstack/query-core'

import {
  type VerifyMessageErrorType,
  type VerifyMessageParameters,
  type VerifyMessageReturnType,
  verifyMessage,
} from '../actions/verifyMessage.js'
import type { Config } from '../createConfig.js'
import type { ScopeKeyParameter } from '../types/properties.js'
import type { Compute, ExactPartial } from '../types/utils.js'
import { filterQueryOptions } from './utils.js'

export type VerifyMessageOptions<config extends Config> = Compute<
  ExactPartial<VerifyMessageParameters<config>> & ScopeKeyParameter
>

export function verifyMessageQueryOptions<config extends Config>(
  config: config,
  options: VerifyMessageOptions<config> = {},
) {
  return {
    async queryFn({ queryKey }) {
      const { address, message, signature } = queryKey[1]
      if (!address || !message || !signature)
        throw new Error('address, message, and signature are required')

      const { scopeKey: _, ...parameters } = queryKey[1]

      const verified = await verifyMessage(
        config,
        parameters as VerifyMessageParameters,
      )
      return verified ?? null
    },
    queryKey: verifyMessageQueryKey(options),
  } as const satisfies QueryOptions<
    VerifyMessageQueryFnData,
    VerifyMessageErrorType,
    VerifyMessageData,
    VerifyMessageQueryKey<config>
  >
}
export type VerifyMessageQueryFnData = VerifyMessageReturnType

export type VerifyMessageData = VerifyMessageQueryFnData

export function verifyMessageQueryKey<config extends Config>(
  options: VerifyMessageOptions<config>,
) {
  return ['verifyMessage', filterQueryOptions(options)] as const
}

export type VerifyMessageQueryKey<config extends Config> = ReturnType<
  typeof verifyMessageQueryKey<config>
>