@azuro-org/sdk
Version:
One-stop solution for building betting dApps on the Azuro Protocol.
54 lines (53 loc) • 2.2 kB
TypeScript
import { type UseQueryResult } from '@tanstack/react-query';
import { type ChainId } from '@azuro-org/toolkit';
import { type QueryParameterWithSelect } from '../../global';
type UseBetFeeResult = {
gasAmount: bigint;
relayerFeeAmount: bigint;
formattedRelayerFeeAmount: string;
};
export type UseBetFeeQueryFnData = UseBetFeeResult;
export type UseBetFeeProps<TData = UseBetFeeQueryFnData> = {
chainId?: ChainId;
query?: QueryParameterWithSelect<UseBetFeeQueryFnData, TData>;
};
export type UseBetFee = <TData = UseBetFeeQueryFnData>(props?: UseBetFeeProps<TData>) => UseQueryResult<TData>;
export type GetUseBetFeeQueryOptionsProps<TData> = UseBetFeeProps<TData> & {
chainId: ChainId;
};
export declare const getUseBetFeeQueryOptions: <TData = UseBetFeeQueryFnData>({ chainId, query }: GetUseBetFeeQueryOptionsProps<TData>) => import("@tanstack/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
gasAmount: bigint;
relayerFeeAmount: bigint;
formattedRelayerFeeAmount: string;
}, Error, TData, readonly unknown[]>, "queryFn"> & {
queryFn?: import("@tanstack/query-core").QueryFunction<{
gasAmount: bigint;
relayerFeeAmount: bigint;
formattedRelayerFeeAmount: string;
}, readonly unknown[], never> | undefined;
} & {
queryKey: readonly unknown[] & {
[dataTagSymbol]: {
gasAmount: bigint;
relayerFeeAmount: bigint;
formattedRelayerFeeAmount: string;
};
[dataTagErrorSymbol]: Error;
};
};
/**
* Fetches current bet placement fee information including gas and relayer fees.
* Auto-refetches every 10 seconds to keep fee estimates up to date.
*
* Returns gas amount, relayer fee amount (as bigint), and formatted relayer fee.
*
* - Docs: https://gem.azuro.org/hub/apps/sdk/data-hooks/useBetFee
*
* @example
* import { useBetFee } from '@azuro-org/sdk'
*
* const { data, isLoading } = useBetFee()
* const { gasAmount, relayerFeeAmount, formattedRelayerFeeAmount } = data || {}
* */
export declare const useBetFee: <TData = UseBetFeeResult>({ chainId, query }?: UseBetFeeProps<TData>) => UseQueryResult<NoInfer<TData>, Error>;
export {};