Optional queryParams: { Optional _defaulted?: booleanOptional _optimisticOptional behavior?: QueryBehavior<unknown, Error, unknown, QueryKey>Optional enabled?: Enabled<unknown, Error, unknown, QueryKey>Optional gcThe time in milliseconds that unused/inactive cache data remains in memory.
When a query's cache becomes unused or inactive, that cache data will be garbage collected after this duration.
When different garbage collection times are specified, the longest one will be used.
Setting it to Infinity will disable garbage collection.
Optional initialOptional initialOptional maxMaximum number of pages to store in the data of an infinite query.
Optional meta?: Record<string, unknown>Additional payload to be stored on each query. Use this property to pass information that can be used in other places.
Optional networkOptional notifyIf set, the component will only re-render if any of the listed properties change.
When set to ['data', 'error'], the component will only re-render when the data or error properties change.
When set to 'all', the component will re-render whenever a query is updated.
When set to a function, the function will be executed to compute the list of properties.
By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.
Optional persister?: ((queryFn, context, query) => unknown)Optional direction?: unknownif you want access to the direction, you can add it to the pageParam
Optional pageOptional placeholderIf set, this value will be used as the placeholder data for this particular query observer while the query is still in the loading data and no initialData has been provided.
Optional queryOptional queryOptional queryOptional queryOptional refetchIf set to a number, the query will continuously refetch at this frequency in milliseconds.
If set to a function, the function will be executed with the latest data and query to compute a frequency
Defaults to false.
Optional refetchIf set to true, the query will continue to refetch while their tab/window is in the background.
Defaults to false.
Optional refetchIf set to true, the query will refetch on mount if the data is stale.
If set to false, will disable additional instances of a query to trigger background refetch.
If set to 'always', the query will always refetch on mount.
If set to a function, the function will be executed with the latest data and query to compute the value
Defaults to true.
Optional refetchIf set to true, the query will refetch on reconnect if the data is stale.
If set to false, the query will not refetch on reconnect.
If set to 'always', the query will always refetch on reconnect.
If set to a function, the function will be executed with the latest data and query to compute the value.
Defaults to the value of networkOnline (true)
Optional refetchIf set to true, the query will refetch on window focus if the data is stale.
If set to false, the query will not refetch on window focus.
If set to 'always', the query will always refetch on window focus.
If set to a function, the function will be executed with the latest data and query to compute the value.
Defaults to true.
Optional retry?: RetryValue<Error>If false, failed queries will not retry by default.
If true, failed queries will retry infinitely., failureCount: num
If set to an integer number, e.g. 3, failed queries will retry until the failed query count meets that number.
If set to a function (failureCount, error) => boolean failed queries will retry until the function returns false.
Optional retryOptional retryIf set to false, the query will not be retried on mount if it contains an error.
Defaults to true.
Optional select?: ((data) => unknown)This option can be used to transform or select a part of the data returned by the query function.
Optional staleThe time in milliseconds after data is considered stale.
If set to Infinity, the data will never be considered stale.
If set to a function, the function will be executed with the query to compute a staleTime.
Optional structuralSet this to false to disable structural sharing between query results.
Set this to a function which accepts the old and new data and returns resolved data of the same type to implement custom structural sharing logic.
Defaults to true.
Optional throwWhether errors should be thrown instead of setting the error property.
If set to true or suspense is true, all errors will be thrown to the error boundary.
If set to false and suspense is false, errors are returned as state.
If set to a function, it will be passed the error and the query, and it should return a boolean indicating whether to show the error in an error boundary (true) or return the error as state (false).
Defaults to false.
This hook retrieves gas estimates for a given set of transactions using the smart account.
import { useGasEstimate } from "@biconomy/useAA";
import { useSmartAccount } from "@/hooks";
import { encodeFunctionData, parseAbi } from "wagmi";
export const GasEstimate = () => {
const { smartAccountAddress } = useSmartAccount();
const mintTx: Transaction = {
to: "0x1758f42Af7026fBbB559Dc60EcE0De3ef81f665e",
data: encodeFunctionData({
abi: parseAbi(["function safeMint(address _to)"]),
functionName: "safeMint",
args: [smartAccountAddress],
}),
};
const { data: gasEstimate, error, isLoading } = useGasEstimate({ transactions: [mintTx] });
if (isLoading) return <div>Loading...</div>;
if (error) return <div>Error: {error.message}</div>;
return (
<div>
Gas Estimate: {gasEstimate ? gasEstimate.toString() : "No estimate available"}
</div>
);
};
Set this to
falseor a function that returnsfalseto disable automatic refetching when the query mounts or changes query keys. To refetch the query, use therefetchmethod returned from theuseQueryinstance. Accepts a boolean or function that returns a boolean. Defaults totrue.