wagmi 0.7.8 → 0.7.10

package/dist/declarations/src/hooks/accounts/useBalance.d.ts

@@ -5,13 +5,4 @@ export declare type UseBalanceArgs = Partial<FetchBalanceArgs> & {
     watch?: boolean;
 };
 export declare type UseBalanceConfig = QueryConfig<FetchBalanceResult, Error>;
-export declare const queryKey: ({ addressOrName, chainId, formatUnits, token, }: Partial<FetchBalanceArgs> & {
-    chainId?: number | undefined;
-}) => readonly [{
-    readonly entity: "balance";
-    readonly addressOrName: string | undefined;
-    readonly chainId: number | undefined;
-    readonly formatUnits: number | "wei" | "kwei" | "mwei" | "gwei" | "szabo" | "finney" | "ether" | undefined;
-    readonly token: `0x${string}` | undefined;
-}];
-export declare function useBalance({ addressOrName, cacheTime, chainId: chainId_, enabled, formatUnits, staleTime, suspense, token, watch, onError, onSettled, onSuccess, }?: UseBalanceArgs & UseBalanceConfig): import("../utils").UseQueryResult<FetchBalanceResult, Error>;
+export declare function useBalance({ addressOrName, cacheTime, chainId: chainId_, enabled, formatUnits, scopeKey, staleTime, suspense, token, watch, onError, onSettled, onSuccess, }?: UseBalanceArgs & UseBalanceConfig): import("../utils").UseQueryResult<FetchBalanceResult, Error>;

package/dist/declarations/src/hooks/contracts/useContractInfiniteReads.d.ts

@@ -15,7 +15,7 @@ export declare type UseContractInfiniteReadsConfig<TContracts extends unknown[]
 export declare function useContractInfiniteReads<TAbi extends Abi | readonly unknown[], TFunctionName extends string, TContracts extends {
     abi: TAbi;
     functionName: TFunctionName;
-}[], TPageParam = any>({ allowFailure, cacheKey, cacheTime, contracts, enabled: enabled_, getNextPageParam, isDataEqual, keepPreviousData, onError, onSettled, onSuccess, overrides, select, staleTime, suspense, }: UseContractInfiniteReadsConfig<TContracts, TPageParam>): UseInfiniteQueryResult<ReadContractsResult<TContracts>, Error>;
+}[], TPageParam = any>({ allowFailure, cacheKey, cacheTime, contracts, enabled: enabled_, getNextPageParam, isDataEqual, keepPreviousData, onError, onSettled, onSuccess, overrides, scopeKey, select, staleTime, suspense, }: UseContractInfiniteReadsConfig<TContracts, TPageParam>): UseInfiniteQueryResult<ReadContractsResult<TContracts>, Error>;
 export declare function paginatedIndexesConfig<TAbi extends Abi | readonly unknown[], TFunctionName extends string, TContracts extends {
     abi: TAbi;
     functionName: TFunctionName;

package/dist/declarations/src/hooks/contracts/useContractRead.d.ts

@@ -12,7 +12,7 @@ export declare type UseContractReadConfig<TAbi = Abi, TFunctionName = string> =
     /** Subscribe to changes */
     watch?: boolean;
 };
-export declare function useContractRead<TAbi extends Abi | readonly unknown[], TFunctionName extends string>({ abi, address, functionName, args, chainId: chainId_, overrides, cacheOnBlock, cacheTime, enabled: enabled_, isDataEqual, select, staleTime, suspense, watch, onError, onSettled, onSuccess, }?: UseContractReadConfig<TAbi, TFunctionName>): import("../utils").UseQueryResult<import("@wagmi/core/internal").GetReturnType<{
+export declare function useContractRead<TAbi extends Abi | readonly unknown[], TFunctionName extends string>({ abi, address, functionName, args, chainId: chainId_, overrides, cacheOnBlock, cacheTime, enabled: enabled_, isDataEqual, scopeKey, select, staleTime, suspense, watch, onError, onSettled, onSuccess, }?: UseContractReadConfig<TAbi, TFunctionName>): import("../utils").UseQueryResult<import("@wagmi/core/internal").GetReturnType<{
     abi: TAbi;
     functionName: TFunctionName;
 }>, Error>;

package/dist/declarations/src/hooks/contracts/useContractReads.d.ts

@@ -17,4 +17,4 @@ export declare type UseContractReadsConfig<TContracts extends unknown[]> = ReadC
 export declare function useContractReads<TAbi extends Abi | readonly unknown[], TFunctionName extends string, TContracts extends {
     abi: TAbi;
     functionName: TFunctionName;
-}[]>({ allowFailure, cacheOnBlock, cacheTime, contracts, overrides, enabled: enabled_, isDataEqual, keepPreviousData, onError, onSettled, onSuccess, select, staleTime, suspense, watch, }?: UseContractReadsConfig<TContracts>): UseQueryResult<ReadContractsResult<TContracts>, Error>;
+}[]>({ allowFailure, cacheOnBlock, cacheTime, scopeKey, contracts, overrides, enabled: enabled_, isDataEqual, keepPreviousData, onError, onSettled, onSuccess, select, staleTime, suspense, watch, }?: UseContractReadsConfig<TContracts>): UseQueryResult<ReadContractsResult<TContracts>, Error>;

package/dist/declarations/src/hooks/contracts/usePrepareContractWrite.d.ts

@@ -24,7 +24,7 @@ export declare type UsePrepareContractWriteConfig<TAbi extends Abi | readonly un
  * const { data, isLoading, isSuccess, write } = useContractWrite(config)
  *
  */
-export declare function usePrepareContractWrite<TAbi extends Abi | readonly unknown[], TFunctionName extends string>({ address, abi, functionName, chainId, args, overrides, cacheTime, enabled, staleTime, suspense, onError, onSettled, onSuccess, }?: UsePrepareContractWriteConfig<TAbi, TFunctionName>): Pick<import("@tanstack/react-query").QueryObserverResult<PrepareWriteContractResult<Abi, string>, Error>, "error" | "data" | "fetchStatus" | "isError" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isLoading" | "isRefetching" | "isSuccess" | "refetch"> & {
+export declare function usePrepareContractWrite<TAbi extends Abi | readonly unknown[], TFunctionName extends string>({ address, abi, functionName, chainId, args, overrides, cacheTime, enabled, scopeKey, staleTime, suspense, onError, onSettled, onSuccess, }?: UsePrepareContractWriteConfig<TAbi, TFunctionName>): Pick<import("@tanstack/react-query").QueryObserverResult<PrepareWriteContractResult<Abi, string>, Error>, "error" | "data" | "fetchStatus" | "isError" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isLoading" | "isRefetching" | "isSuccess" | "refetch"> & {
     isIdle: boolean;
     status: "error" | "success" | "idle" | "loading";
     internal: Pick<import("@tanstack/react-query").QueryObserverResult<unknown, unknown>, "failureCount" | "isPaused" | "dataUpdatedAt" | "errorUpdatedAt" | "isLoadingError" | "isPlaceholderData" | "isPreviousData" | "isRefetchError" | "isStale" | "remove">;

package/dist/declarations/src/hooks/contracts/useToken.d.ts

@@ -2,13 +2,5 @@ import { FetchTokenArgs, FetchTokenResult } from '@wagmi/core';
 import { QueryConfig } from '../../types';
 export declare type UseTokenArgs = Partial<FetchTokenArgs>;
 export declare type UseTokenConfig = QueryConfig<FetchTokenResult, Error>;
-export declare const queryKey: ({ address, chainId, formatUnits, }: Partial<FetchTokenArgs> & {
-    chainId?: number | undefined;
-}) => readonly [{
-    readonly entity: "token";
-    readonly address: `0x${string}` | undefined;
-    readonly chainId: number | undefined;
-    readonly formatUnits: number | "wei" | "kwei" | "mwei" | "gwei" | "szabo" | "finney" | "ether" | undefined;
-}];
-export declare function useToken({ address, chainId: chainId_, formatUnits, cacheTime, enabled, staleTime, // 24 hours
+export declare function useToken({ address, chainId: chainId_, formatUnits, cacheTime, enabled, scopeKey, staleTime, // 24 hours
 suspense, onError, onSettled, onSuccess, }?: UseTokenArgs & UseTokenConfig): import("../utils").UseQueryResult<FetchTokenResult, Error>;

package/dist/declarations/src/hooks/ens/useEnsAddress.d.ts

@@ -2,13 +2,5 @@ import { FetchEnsAddressArgs, FetchEnsAddressResult } from '@wagmi/core';
 import { QueryConfig } from '../../types';
 export declare type UseEnsAddressArgs = Partial<FetchEnsAddressArgs>;
 export declare type UseEnsAddressConfig = QueryConfig<FetchEnsAddressResult, Error>;
-export declare const queryKey: ({ chainId, name, }: {
-    chainId?: number | undefined;
-    name?: string | undefined;
-}) => readonly [{
-    readonly entity: "ensAddress";
-    readonly chainId: number | undefined;
-    readonly name: string | undefined;
-}];
-export declare function useEnsAddress({ cacheTime, chainId: chainId_, enabled, name, staleTime, // 24 hours
+export declare function useEnsAddress({ cacheTime, chainId: chainId_, enabled, name, scopeKey, staleTime, // 24 hours
 suspense, onError, onSettled, onSuccess, }?: UseEnsAddressArgs & UseEnsAddressConfig): import("../utils").UseQueryResult<FetchEnsAddressResult, Error>;

package/dist/declarations/src/hooks/ens/useEnsAvatar.d.ts

@@ -2,13 +2,5 @@ import { FetchEnsAvatarArgs, FetchEnsAvatarResult } from '@wagmi/core';
 import { QueryConfig } from '../../types';
 export declare type UseEnsAvatarArgs = Partial<FetchEnsAvatarArgs>;
 export declare type UseEnsLookupConfig = QueryConfig<FetchEnsAvatarResult, Error>;
-export declare const queryKey: ({ addressOrName, chainId, }: {
-    addressOrName?: UseEnsAvatarArgs['addressOrName'];
-    chainId?: number | undefined;
-}) => readonly [{
-    readonly entity: "ensAvatar";
-    readonly addressOrName: string | undefined;
-    readonly chainId: number | undefined;
-}];
-export declare function useEnsAvatar({ addressOrName, cacheTime, chainId: chainId_, enabled, staleTime, // 24 hours
+export declare function useEnsAvatar({ addressOrName, cacheTime, chainId: chainId_, enabled, scopeKey, staleTime, // 24 hours
 suspense, onError, onSettled, onSuccess, }?: UseEnsAvatarArgs & UseEnsLookupConfig): import("../utils").UseQueryResult<FetchEnsAvatarResult, Error>;

package/dist/declarations/src/hooks/ens/useEnsName.d.ts

@@ -2,10 +2,5 @@ import { FetchEnsNameArgs, FetchEnsNameResult } from '@wagmi/core';
 import { QueryConfig } from '../../types';
 export declare type UseEnsNameArgs = Partial<FetchEnsNameArgs>;
 export declare type UseEnsNameConfig = QueryConfig<FetchEnsNameResult, Error>;
-export declare const queryKey: ({ address, chainId }: Partial<FetchEnsNameArgs>) => readonly [{
-    readonly entity: "ensName";
-    readonly address: `0x${string}` | undefined;
-    readonly chainId: number | undefined;
-}];
-export declare function useEnsName({ address, cacheTime, chainId: chainId_, enabled, staleTime, // 24 hours
+export declare function useEnsName({ address, cacheTime, chainId: chainId_, enabled, scopeKey, staleTime, // 24 hours
 suspense, onError, onSettled, onSuccess, }?: UseEnsNameArgs & UseEnsNameConfig): import("../utils").UseQueryResult<FetchEnsNameResult, Error>;

package/dist/declarations/src/hooks/ens/useEnsResolver.d.ts

@@ -2,13 +2,5 @@ import { FetchEnsResolverArgs, FetchEnsResolverResult } from '@wagmi/core';
 import { QueryConfig } from '../../types';
 export declare type UseEnsResolverArgs = Partial<FetchEnsResolverArgs>;
 export declare type UseEnsResolverConfig = QueryConfig<FetchEnsResolverResult, Error>;
-export declare const queryKey: ({ chainId, name, }: {
-    chainId?: number | undefined;
-    name?: string | undefined;
-}) => readonly [{
-    readonly entity: "ensResolver";
-    readonly chainId: number | undefined;
-    readonly name: string | undefined;
-}];
-export declare function useEnsResolver({ cacheTime, chainId: chainId_, enabled, name, staleTime, // 24 hours
+export declare function useEnsResolver({ cacheTime, chainId: chainId_, name, enabled, scopeKey, staleTime, // 24 hours
 suspense, onError, onSettled, onSuccess, }?: UseEnsResolverArgs & UseEnsResolverConfig): import("../utils").UseQueryResult<FetchEnsResolverResult, Error>;

package/dist/declarations/src/hooks/network-status/useBlockNumber.d.ts

@@ -1,17 +1,10 @@
 import { FetchBlockNumberArgs, FetchBlockNumberResult } from '@wagmi/core';
 import { QueryConfig } from '../../types';
-declare type UseBlockNumberArgs = Partial<FetchBlockNumberArgs> & {
+export declare type UseBlockNumberArgs = Partial<FetchBlockNumberArgs> & {
     /** Function fires when a new block is created */
     onBlock?: (blockNumber: number) => void;
     /** Subscribe to changes */
     watch?: boolean;
 };
 export declare type UseBlockNumberConfig = QueryConfig<FetchBlockNumberResult, Error>;
-export declare const queryKey: ({ chainId }: {
-    chainId?: number | undefined;
-}) => readonly [{
-    readonly entity: "blockNumber";
-    readonly chainId: number | undefined;
-}];
-export declare function useBlockNumber({ cacheTime, chainId: chainId_, enabled, staleTime, suspense, watch, onBlock, onError, onSettled, onSuccess, }?: UseBlockNumberArgs & UseBlockNumberConfig): import("../utils").UseQueryResult<number, Error>;
-export {};
+export declare function useBlockNumber({ cacheTime, chainId: chainId_, enabled, scopeKey, staleTime, suspense, watch, onBlock, onError, onSettled, onSuccess, }?: UseBlockNumberArgs & UseBlockNumberConfig): import("../utils").UseQueryResult<number, Error>;

package/dist/declarations/src/hooks/network-status/useFeeData.d.ts

@@ -1,16 +1,8 @@
 import { FetchFeeDataArgs, FetchFeeDataResult } from '@wagmi/core';
 import { QueryConfig } from '../../types';
-declare type UseFeeDataArgs = Partial<FetchFeeDataArgs> & {
+export declare type UseFeeDataArgs = Partial<FetchFeeDataArgs> & {
     /** Subscribe to changes */
     watch?: boolean;
 };
 export declare type UseFeedDataConfig = QueryConfig<FetchFeeDataResult, Error>;
-export declare const queryKey: ({ chainId, formatUnits, }: Partial<FetchFeeDataArgs> & {
-    chainId?: number | undefined;
-}) => readonly [{
-    readonly entity: "feeData";
-    readonly chainId: number | undefined;
-    readonly formatUnits: number | "wei" | "kwei" | "mwei" | "gwei" | "szabo" | "finney" | "ether" | undefined;
-}];
-export declare function useFeeData({ cacheTime, chainId: chainId_, enabled, formatUnits, staleTime, suspense, watch, onError, onSettled, onSuccess, }?: UseFeeDataArgs & UseFeedDataConfig): import("../utils").UseQueryResult<FetchFeeDataResult, Error>;
-export {};
+export declare function useFeeData({ cacheTime, chainId: chainId_, enabled, formatUnits, scopeKey, staleTime, suspense, watch, onError, onSettled, onSuccess, }?: UseFeeDataArgs & UseFeedDataConfig): import("../utils").UseQueryResult<FetchFeeDataResult, Error>;

package/dist/declarations/src/hooks/transactions/usePrepareSendTransaction.d.ts

@@ -15,7 +15,7 @@ export declare type UsePrepareSendTransactionConfig = Partial<PrepareSendTransac
  * })
  * const result = useSendTransaction(config)
  */
-export declare function usePrepareSendTransaction({ chainId, request, cacheTime, enabled, staleTime, // 24 hours
+export declare function usePrepareSendTransaction({ chainId, request, cacheTime, enabled, scopeKey, staleTime, // 24 hours
 suspense, onError, onSettled, onSuccess, }?: UsePrepareSendTransactionConfig): Pick<import("@tanstack/react-query").QueryObserverResult<PrepareSendTransactionResult, Error>, "error" | "data" | "fetchStatus" | "isError" | "isFetched" | "isFetchedAfterMount" | "isFetching" | "isLoading" | "isRefetching" | "isSuccess" | "refetch"> & {
     isIdle: boolean;
     status: "error" | "success" | "idle" | "loading";

package/dist/declarations/src/hooks/transactions/useTransaction.d.ts

@@ -1,6 +1,6 @@
 import { FetchTransactionArgs, FetchTransactionResult } from '@wagmi/core';
 import { QueryConfig } from '../../types';
-declare type UseTransactionArgs = Partial<FetchTransactionArgs>;
+export declare type UseTransactionArgs = Partial<FetchTransactionArgs>;
 export declare type UseTransactionConfig = QueryConfig<FetchTransactionResult, Error>;
 /**
  * @description Fetches transaction for hash
@@ -13,5 +13,4 @@ export declare type UseTransactionConfig = QueryConfig<FetchTransactionResult, E
  *  hash: '0x...',
  * })
  */
-export declare function useTransaction({ cacheTime, chainId: chainId_, enabled, hash, staleTime, suspense, onError, onSettled, onSuccess, }?: UseTransactionArgs & UseTransactionConfig): import("../utils").UseQueryResult<import("@ethersproject/providers").TransactionResponse, Error>;
-export {};
+export declare function useTransaction({ cacheTime, chainId: chainId_, enabled, hash, scopeKey, staleTime, suspense, onError, onSettled, onSuccess, }?: UseTransactionArgs & UseTransactionConfig): import("../utils").UseQueryResult<import("@ethersproject/providers").TransactionResponse, Error>;

package/dist/declarations/src/hooks/transactions/useWaitForTransaction.d.ts

@@ -2,12 +2,4 @@ import { WaitForTransactionArgs, WaitForTransactionResult } from '@wagmi/core';
 import { QueryConfig } from '../../types';
 export declare type UseWaitForTransactionArgs = Partial<WaitForTransactionArgs>;
 export declare type UseWaitForTransactionConfig = QueryConfig<WaitForTransactionResult, Error>;
-export declare const queryKey: ({ confirmations, chainId, hash, timeout, wait, }: Partial<WaitForTransactionArgs>) => readonly [{
-    readonly entity: "waitForTransaction";
-    readonly confirmations: number | undefined;
-    readonly chainId: number | undefined;
-    readonly hash: `0x${string}` | undefined;
-    readonly timeout: number | undefined;
-    readonly wait: ((confirmations?: number | undefined) => Promise<import("@ethersproject/providers").TransactionReceipt>) | undefined;
-}];
-export declare function useWaitForTransaction({ chainId: chainId_, confirmations, hash, timeout, wait, cacheTime, enabled, staleTime, suspense, onError, onSettled, onSuccess, }?: UseWaitForTransactionArgs & UseWaitForTransactionConfig): import("../utils").UseQueryResult<import("@ethersproject/providers").TransactionReceipt, Error>;
+export declare function useWaitForTransaction({ chainId: chainId_, confirmations, hash, timeout, wait, cacheTime, enabled, scopeKey, staleTime, suspense, onError, onSettled, onSuccess, }?: UseWaitForTransactionArgs & UseWaitForTransactionConfig): import("../utils").UseQueryResult<import("@ethersproject/providers").TransactionReceipt, Error>;

package/dist/declarations/src/index.d.ts

@@ -4,6 +4,6 @@ export { Context, WagmiConfig, useClient } from './context';
 export type { WagmiConfigProps } from './context';
 export { paginatedIndexesConfig, useAccount, useBalance, useBlockNumber, useConnect, useContract, useContractEvent, useContractInfiniteReads, useContractRead, useContractReads, useContractWrite, useDisconnect, useEnsAddress, useEnsAvatar, useEnsName, useEnsResolver, useFeeData, useInfiniteQuery, useMutation, useNetwork, useProvider, useQuery, useQueryClient, useSendTransaction, usePrepareContractWrite, usePrepareSendTransaction, useSignMessage, useSignTypedData, useSigner, useSwitchNetwork, useToken, useTransaction, useWaitForTransaction, useWebSocketProvider, } from './hooks';
 export { deserialize, serialize } from './utils';
-export { AddChainError, ChainDoesNotSupportMulticallError, ChainMismatchError, ChainNotConfiguredError, Connector, ConnectorAlreadyConnectedError, ConnectorNotFoundError, ContractMethodDoesNotExistError, ContractMethodNoResultError, ContractMethodRevertedError, ContractResultDecodeError, ProviderChainsNotFound, ProviderRpcError, ResourceUnavailableError, RpcError, SwitchChainError, SwitchChainNotSupportedError, UserRejectedRequestError, alchemyRpcUrls, allChains, chain, chainId, configureChains, createStorage, deepEqual, defaultChains, defaultL2Chains, erc20ABI, erc721ABI, etherscanBlockExplorers, infuraRpcUrls, publicRpcUrls, readContracts, } from '@wagmi/core';
+export { AddChainError, ChainDoesNotSupportMulticallError, ChainMismatchError, ChainNotConfiguredError, Connector, ConnectorAlreadyConnectedError, ConnectorNotFoundError, ContractMethodDoesNotExistError, ContractMethodNoResultError, ContractMethodRevertedError, ContractResultDecodeError, ProviderChainsNotFound, ProviderRpcError, ResourceUnavailableError, RpcError, SwitchChainError, SwitchChainNotSupportedError, UserRejectedRequestError, alchemyRpcUrls, allChains, chain, chainId, configureChains, createStorage, deepEqual, defaultChains, defaultL2Chains, erc20ABI, erc721ABI, erc4626ABI, etherscanBlockExplorers, infuraRpcUrls, publicRpcUrls, readContracts, } from '@wagmi/core';
 export type { Chain, ChainProviderFn, ConnectorData, ConnectorEvents, Storage, Unit, } from '@wagmi/core';
 export type { Address } from 'abitype';

package/dist/declarations/src/types/index.d.ts

@@ -20,8 +20,14 @@ declare module 'ethers/lib/utils' {
     } | ResolvedConfig['BytesType'] | string): string;
 }
 export declare type QueryFunctionArgs<T extends (...args: any) => any> = QueryFunctionContext<ReturnType<T>>;
-export declare type QueryConfig<Data, Error> = Pick<UseQueryOptions<Data, Error>, 'cacheTime' | 'enabled' | 'isDataEqual' | 'keepPreviousData' | 'staleTime' | 'select' | 'suspense' | 'onError' | 'onSettled' | 'onSuccess'>;
-export declare type InfiniteQueryConfig<Data, Error> = Pick<UseInfiniteQueryOptions<Data, Error>, 'cacheTime' | 'enabled' | 'getNextPageParam' | 'isDataEqual' | 'keepPreviousData' | 'select' | 'staleTime' | 'suspense' | 'onError' | 'onSettled' | 'onSuccess'>;
+export declare type QueryConfig<Data, Error> = Pick<UseQueryOptions<Data, Error>, 'cacheTime' | 'enabled' | 'isDataEqual' | 'keepPreviousData' | 'staleTime' | 'select' | 'suspense' | 'onError' | 'onSettled' | 'onSuccess'> & {
+    /** Scope the cache to a given context. */
+    scopeKey?: string;
+};
+export declare type InfiniteQueryConfig<Data, Error> = Pick<UseInfiniteQueryOptions<Data, Error>, 'cacheTime' | 'enabled' | 'getNextPageParam' | 'isDataEqual' | 'keepPreviousData' | 'select' | 'staleTime' | 'suspense' | 'onError' | 'onSettled' | 'onSuccess'> & {
+    /** Scope the cache to a given context. */
+    scopeKey?: string;
+};
 export declare type MutationConfig<Data, Error, Variables = void> = {
     /** Function fires if mutation encounters error */
     onError?: UseMutationOptions<Data, Error, Variables>['onError'];