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

VanillaJS library for Ethereum

import type { FeeValuesType } from 'viem'

import {
  type EstimateFeesPerGasErrorType,
  type EstimateFeesPerGasParameters,
  type EstimateFeesPerGasReturnType,
  estimateFeesPerGas,
} from '../actions/estimateFeesPerGas.js'
import type { Config } from '../createConfig.js'
import type { ScopeKeyParameter } from '../types/properties.js'
import type { QueryOptions, QueryParameter } from '../types/query.js'
import type { Compute, ExactPartial } from '../types/utils.js'
import { filterQueryOptions } from './utils.js'

export type EstimateFeesPerGasOptions<
  type extends FeeValuesType,
  config extends Config,
  selectData = EstimateFeesPerGasData<type>,
> = Compute<
  ExactPartial<EstimateFeesPerGasParameters<type, config>> & ScopeKeyParameter
> &
  QueryParameter<
    EstimateFeesPerGasQueryFnData<type>,
    EstimateFeesPerGasErrorType,
    selectData,
    EstimateFeesPerGasQueryKey<config, type>
  >

export function estimateFeesPerGasQueryOptions<
  config extends Config,
  type extends FeeValuesType = 'eip1559',
  selectData = EstimateFeesPerGasData<type>,
>(
  config: config,
  options: EstimateFeesPerGasOptions<type, config, selectData> = {},
): EstimateFeesPerGasQueryOptions<type, config, selectData> {
  return {
    ...options.query,
    queryFn: async (context) => {
      const [, { scopeKey: _, ...parameters }] = context.queryKey
      return estimateFeesPerGas(config, parameters)
    },
    queryKey: estimateFeesPerGasQueryKey(options),
  }
}

export type EstimateFeesPerGasQueryFnData<type extends FeeValuesType> =
  EstimateFeesPerGasReturnType<type>

export type EstimateFeesPerGasData<type extends FeeValuesType> =
  EstimateFeesPerGasQueryFnData<type>

export function estimateFeesPerGasQueryKey<
  config extends Config,
  type extends FeeValuesType = 'eip1559',
>(
  options: Compute<
    ExactPartial<EstimateFeesPerGasParameters<type, config>> & ScopeKeyParameter
  > = {},
) {
  return ['estimateFeesPerGas', filterQueryOptions(options)] as const
}

export type EstimateFeesPerGasQueryKey<
  config extends Config,
  type extends FeeValuesType,
> = ReturnType<typeof estimateFeesPerGasQueryKey<config, type>>

export type EstimateFeesPerGasQueryOptions<
  type extends FeeValuesType,
  config extends Config,
  selectData = EstimateFeesPerGasData<type>,
> = QueryOptions<
  EstimateFeesPerGasQueryFnData<type>,
  EstimateFeesPerGasErrorType,
  selectData,
  EstimateFeesPerGasQueryKey<config, type>
>