wagmi 0.3.0-next.9 → 0.3.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Tom Meagher
+Copyright (c) 2022 awkweb.eth
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,83 +1,30 @@
-# wagmi [![Version](https://img.shields.io/npm/v/wagmi?colorA=292929&colorB=3c82f6)](https://www.npmjs.com/package/wagmi) [![Downloads](https://img.shields.io/npm/dm/wagmi?colorA=292929&colorB=3c82f6)](https://www.npmjs.com/package/wagmi) [![Sponsors](https://img.shields.io/github/sponsors/tmm?colorA=292929&colorB=3c82f6)](https://github.com/sponsors/tmm)
-
-> React Hooks for Ethereum
-
-**wagmi** is a collection of React Hooks containing everything you need to start working with Ethereum. wagmi makes it easy to "Connect Wallet," display ENS and balance information, sign messages, interact with contracts, and much more — all with caching, request deduplication, and persistence.
-
-## Features
-
-- 🚀 20+ hooks for working with wallets, ENS, contracts, transactions, signing, etc.
-- 💼 Built-in wallet connectors for MetaMask, WalletConnect, and Coinbase Wallet
-- 🌀 Auto-refresh data on wallet and network changes
-- 🦄 TypeScript ready
-- 💨 Zero-dependencies (besides ethers.js peer dependency)
-- 🌳 Test suite and documentation
-- 📖 MIT License
+# wagmi
 
 ## Documentation
 
-Visit https://wagmi.sh to view the full documentation.
+For full documentation and examples, visit [wagmi.sh](https://wagmi.sh).
 
-## Usage
+## Installation
 
-1. Install the dependencies.
+Install wagmi and its ethers peer dependency.
 
 ```bash
-npm add wagmi ethers
-```
-
-2. Wrap your app with the `Provider` component.
-
-```tsx
-import { Provider } from 'wagmi'
-
-const App = () => (
-  <Provider>
-    <YourRoutes />
-  </Provider>
-)
+npm install wagmi ethers
 ```
 
-3. Use hooks.
-
-```tsx
-import { useAccount } from 'wagmi'
-
-const Page = () => {
-  const [{ data, error, loading }, disconnect] = useAccount({
-    fetchEns: true,
-  })
-
-  return ...
-}
-```
-
-Every component inside the `Provider` is set up with the default `InjectedConnector` for connecting wallets and ethers.js [Default Provider](https://docs.ethers.io/v5/api/providers/#providers-getDefaultProvider) for fetching data.
-
-Want to learn more? Check out the [guides](https://wagmi-xyz.vercel.app/guides/connect-wallet) or browse the [API docs](https://wagmi-xyz.vercel.app/docs/provider).
-
 ## Community
 
+Check out the following places for more wagmi-related content:
+
 - Join the [discussions on GitHub](https://github.com/tmm/wagmi/discussions)
 - Follow [@awkweb](https://twitter.com/awkweb) on Twitter for project updates
 - Sign the [guestbook](https://github.com/tmm/wagmi/discussions/2)
-- Share [your project/organization](https://github.com/tmm/wagmi/discussions/201) that uses wagmi
+- Share [your project/organization](https://github.com/tmm/wagmi/discussions/201) using wagmi
 
 ## Support
 
-- awkweb.eth
-- [GitHub Sponsors](https://github.com/sponsors/tmm)
-- [Gitcoin Grant](https://gitcoin.co/grants/4493/wagmi-react-hooks-library-for-ethereum)
-
-## Thanks
+If you find wagmi useful, please consider supporting development. Thank you 🙏
 
-- [ricmoo.eth](https://twitter.com/ricmoo) for creating and continued work on [ethers.js](https://github.com/ethers-io/ethers.js)
-- [Mirror](https://mirror.xyz) for creating space to do good work
-
-## License
-
-MIT.
-
-<br />
-
-wagmi frens
+- [awkweb.eth](https://etherscan.io/enslookup-search?search=awkweb.eth)
+- [GitHub Sponsors](https://github.com/sponsors/tmm?metadata_campaign=readme_wagmi)
+- [Gitcoin Grant](https://gitcoin.co/grants/4493/wagmi-react-hooks-library-for-ethereum)

package/connectors/metaMask/dist/wagmi-connectors-metaMask.cjs.d.ts

@@ -0,0 +1 @@
+export * from "../../../dist/declarations/src/connectors/metaMask";

package/connectors/metaMask/dist/wagmi-connectors-metaMask.cjs.dev.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var metaMask = require('@wagmi/core/connectors/metaMask');
+
+
+
+Object.defineProperty(exports, 'MetaMaskConnector', {
+	enumerable: true,
+	get: function () { return metaMask.MetaMaskConnector; }
+});

package/connectors/metaMask/dist/wagmi-connectors-metaMask.cjs.js

@@ -0,0 +1,7 @@
+'use strict';
+
+if (process.env.NODE_ENV === "production") {
+  module.exports = require("./wagmi-connectors-metaMask.cjs.prod.js");
+} else {
+  module.exports = require("./wagmi-connectors-metaMask.cjs.dev.js");
+}

package/connectors/metaMask/dist/wagmi-connectors-metaMask.cjs.prod.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var metaMask = require('@wagmi/core/connectors/metaMask');
+
+
+
+Object.defineProperty(exports, 'MetaMaskConnector', {
+	enumerable: true,
+	get: function () { return metaMask.MetaMaskConnector; }
+});

package/connectors/metaMask/dist/wagmi-connectors-metaMask.esm.js

@@ -0,0 +1 @@
+export { MetaMaskConnector } from '@wagmi/core/connectors/metaMask';

package/connectors/metaMask/package.json

@@ -0,0 +1,4 @@
+{
+  "main": "dist/wagmi-connectors-metaMask.cjs.js",
+  "module": "dist/wagmi-connectors-metaMask.esm.js"
+}

package/dist/declarations/src/connectors/metaMask.d.ts

@@ -0,0 +1 @@
+export { MetaMaskConnector } from '@wagmi/core/connectors/metaMask';

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

@@ -1,16 +1,22 @@
 import * as React from 'react';
+import type { BaseProvider, WebSocketProvider } from '@ethersproject/providers';
 import { WagmiClient, ClientConfig as WagmiClientConfig } from '@wagmi/core';
 import { QueryClient } from 'react-query';
-export declare const Context: React.Context<WagmiClient | undefined>;
-export declare type ClientConfig = WagmiClientConfig & {
+import { Persister } from 'react-query/persistQueryClient';
+export declare type DecoratedWagmiClient<TProvider extends BaseProvider = BaseProvider, TWebSocketProvider extends WebSocketProvider = WebSocketProvider> = WagmiClient<TProvider, TWebSocketProvider> & {
+    queryClient: QueryClient;
+};
+export declare const Context: React.Context<DecoratedWagmiClient<BaseProvider, WebSocketProvider> | undefined>;
+export declare type ClientConfig<TProvider extends BaseProvider = BaseProvider, TWebSocketProvider extends WebSocketProvider = WebSocketProvider> = WagmiClientConfig<TProvider, TWebSocketProvider> & {
     queryClient?: QueryClient;
+    persister?: Persister;
 };
-export declare function createClient({ queryClient, ...config }?: ClientConfig): WagmiClient & {
+export declare function createClient<TProvider extends BaseProvider, TWebSocketProvider extends WebSocketProvider>({ queryClient, persister, ...config }?: ClientConfig<TProvider, TWebSocketProvider>): WagmiClient<TProvider, TWebSocketProvider> & {
     queryClient: QueryClient;
 };
-export declare type ProviderProps = {
+export declare type ProviderProps<TProvider extends BaseProvider = BaseProvider, TWebSocketProvider extends WebSocketProvider = WebSocketProvider> = {
     /** React-decorated WagmiClient instance */
-    client?: ReturnType<typeof createClient>;
+    client?: DecoratedWagmiClient<TProvider, TWebSocketProvider>;
 };
-export declare function Provider({ children, client, }: React.PropsWithChildren<ProviderProps>): JSX.Element;
-export declare function useClient(): WagmiClient;
+export declare function Provider<TProvider extends BaseProvider, TWebSocketProvider extends WebSocketProvider>({ children, client, }: React.PropsWithChildren<ProviderProps<TProvider, TWebSocketProvider>>): JSX.Element;
+export declare function useClient<TProvider extends BaseProvider, TWebSocketProvider extends WebSocketProvider = WebSocketProvider>(): DecoratedWagmiClient<TProvider, TWebSocketProvider>;

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

@@ -1,6 +1,7 @@
 export { useAccount } from './useAccount';
 export { useBalance } from './useBalance';
 export { useConnect } from './useConnect';
+export { useDisconnect } from './useDisconnect';
 export { useNetwork } from './useNetwork';
 export { useSigner } from './useSigner';
 export { useSignMessage } from './useSignMessage';

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

@@ -1,184 +1,11 @@
-import { GetAccountResult, disconnect } from '@wagmi/core';
+import { GetAccountResult } from '@wagmi/core';
 import { QueryConfig } from '../../types';
-export declare type UseAccountArgs = {
-    /** Fetches ENS for connected account */
-    ens?: boolean | {
-        avatar?: boolean;
-        name?: boolean;
-    };
-};
-export declare type UseAccountConfig = QueryConfig<GetAccountResult, Error>;
+export declare type UseAccountConfig = Pick<QueryConfig<GetAccountResult, Error>, 'suspense' | 'onError' | 'onSettled' | 'onSuccess'>;
 export declare const queryKey: () => readonly [{
     readonly entity: "account";
 }];
-export declare function useAccount({ ens, cacheTime, enabled, keepPreviousData, select, staleTime, suspense, onError, onSettled, onSuccess, }?: UseAccountArgs & UseAccountConfig): {
-    readonly data: {
-        ens: {
-            avatar: import("@wagmi/core").FetchEnsAvatarResult | undefined;
-            name: import("@wagmi/core").FetchEnsNameResult | undefined;
-        };
-        address: string;
-        connector?: import("@wagmi/core").Connector<any, any> | undefined;
-    } | {
-        ens?: undefined;
-        address: string;
-        connector?: import("@wagmi/core").Connector<any, any> | undefined;
-    } | undefined;
-    readonly disconnect: typeof disconnect;
-    readonly error: Error | null;
-    readonly isError: boolean;
-    readonly isIdle: boolean;
-    readonly isLoading: boolean;
-    readonly isSuccess: boolean;
-    readonly status: "error" | "idle" | "loading" | "success";
-    readonly isLoadingError: false;
-    readonly isRefetchError: false;
-    readonly dataUpdatedAt: number;
-    readonly errorUpdatedAt: number;
-    readonly failureCount: number;
-    readonly isFetched: boolean;
-    readonly isFetchedAfterMount: boolean;
-    readonly isFetching: boolean;
-    readonly isPlaceholderData: boolean;
-    readonly isPreviousData: boolean;
-    readonly isRefetching: boolean;
-    readonly isStale: boolean;
-    readonly refetch: <TPageData>(options?: (import("react-query").RefetchOptions & import("react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("react-query").QueryObserverResult<GetAccountResult, Error>>;
-    readonly remove: () => void;
-} | {
-    readonly data: {
-        ens: {
-            avatar: import("@wagmi/core").FetchEnsAvatarResult | undefined;
-            name: import("@wagmi/core").FetchEnsNameResult | undefined;
-        };
-        address: string;
-        connector?: import("@wagmi/core").Connector<any, any> | undefined;
-    } | {
-        ens?: undefined;
-        address: string;
-        connector?: import("@wagmi/core").Connector<any, any> | undefined;
-    } | undefined;
-    readonly disconnect: typeof disconnect;
-    readonly error: Error | null;
-    readonly isError: boolean;
-    readonly isIdle: boolean;
-    readonly isLoading: boolean;
-    readonly isSuccess: boolean;
-    readonly status: "error" | "idle" | "loading" | "success";
-    readonly isLoadingError: true;
-    readonly isRefetchError: false;
-    readonly dataUpdatedAt: number;
-    readonly errorUpdatedAt: number;
-    readonly failureCount: number;
-    readonly isFetched: boolean;
-    readonly isFetchedAfterMount: boolean;
-    readonly isFetching: boolean;
-    readonly isPlaceholderData: boolean;
-    readonly isPreviousData: boolean;
-    readonly isRefetching: boolean;
-    readonly isStale: boolean;
-    readonly refetch: <TPageData>(options?: (import("react-query").RefetchOptions & import("react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("react-query").QueryObserverResult<GetAccountResult, Error>>;
-    readonly remove: () => void;
-} | {
-    readonly data: {
-        ens: {
-            avatar: import("@wagmi/core").FetchEnsAvatarResult | undefined;
-            name: import("@wagmi/core").FetchEnsNameResult | undefined;
-        };
-        address: string;
-        connector?: import("@wagmi/core").Connector<any, any> | undefined;
-    } | {
-        ens?: undefined;
-        address: string;
-        connector?: import("@wagmi/core").Connector<any, any> | undefined;
-    } | undefined;
-    readonly disconnect: typeof disconnect;
-    readonly error: Error | null;
-    readonly isError: boolean;
-    readonly isIdle: boolean;
-    readonly isLoading: boolean;
-    readonly isSuccess: boolean;
-    readonly status: "error" | "idle" | "loading" | "success";
-    readonly isLoadingError: false;
-    readonly isRefetchError: false;
-    readonly dataUpdatedAt: number;
-    readonly errorUpdatedAt: number;
-    readonly failureCount: number;
-    readonly isFetched: boolean;
-    readonly isFetchedAfterMount: boolean;
-    readonly isFetching: boolean;
-    readonly isPlaceholderData: boolean;
-    readonly isPreviousData: boolean;
-    readonly isRefetching: boolean;
-    readonly isStale: boolean;
-    readonly refetch: <TPageData>(options?: (import("react-query").RefetchOptions & import("react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("react-query").QueryObserverResult<GetAccountResult, Error>>;
-    readonly remove: () => void;
-} | {
-    readonly data: {
-        ens: {
-            avatar: import("@wagmi/core").FetchEnsAvatarResult | undefined;
-            name: import("@wagmi/core").FetchEnsNameResult | undefined;
-        };
-        address: string;
-        connector?: import("@wagmi/core").Connector<any, any> | undefined;
-    } | {
-        ens?: undefined;
-        address: string;
-        connector?: import("@wagmi/core").Connector<any, any> | undefined;
-    } | undefined;
-    readonly disconnect: typeof disconnect;
-    readonly error: Error | null;
-    readonly isError: boolean;
-    readonly isIdle: boolean;
-    readonly isLoading: boolean;
-    readonly isSuccess: boolean;
-    readonly status: "error" | "idle" | "loading" | "success";
-    readonly isLoadingError: false;
-    readonly isRefetchError: true;
-    readonly dataUpdatedAt: number;
-    readonly errorUpdatedAt: number;
-    readonly failureCount: number;
-    readonly isFetched: boolean;
-    readonly isFetchedAfterMount: boolean;
-    readonly isFetching: boolean;
-    readonly isPlaceholderData: boolean;
-    readonly isPreviousData: boolean;
-    readonly isRefetching: boolean;
-    readonly isStale: boolean;
-    readonly refetch: <TPageData>(options?: (import("react-query").RefetchOptions & import("react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("react-query").QueryObserverResult<GetAccountResult, Error>>;
-    readonly remove: () => void;
-} | {
-    readonly data: {
-        ens: {
-            avatar: import("@wagmi/core").FetchEnsAvatarResult | undefined;
-            name: import("@wagmi/core").FetchEnsNameResult | undefined;
-        };
-        address: string;
-        connector?: import("@wagmi/core").Connector<any, any> | undefined;
-    } | {
-        ens?: undefined;
-        address: string;
-        connector?: import("@wagmi/core").Connector<any, any> | undefined;
-    } | undefined;
-    readonly disconnect: typeof disconnect;
-    readonly error: Error | null;
-    readonly isError: boolean;
-    readonly isIdle: boolean;
-    readonly isLoading: boolean;
-    readonly isSuccess: boolean;
-    readonly status: "error" | "idle" | "loading" | "success";
-    readonly isLoadingError: false;
-    readonly isRefetchError: false;
-    readonly dataUpdatedAt: number;
-    readonly errorUpdatedAt: number;
-    readonly failureCount: number;
-    readonly isFetched: boolean;
-    readonly isFetchedAfterMount: boolean;
-    readonly isFetching: boolean;
-    readonly isPlaceholderData: boolean;
-    readonly isPreviousData: boolean;
-    readonly isRefetching: boolean;
-    readonly isStale: boolean;
-    readonly refetch: <TPageData>(options?: (import("react-query").RefetchOptions & import("react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("react-query").QueryObserverResult<GetAccountResult, Error>>;
-    readonly remove: () => void;
+export declare function useAccount({ suspense, onError, onSettled, onSuccess, }?: UseAccountConfig): Pick<import("react-query").QueryObserverResult<GetAccountResult<import("@ethersproject/providers").BaseProvider>, Error>, "data" | "error" | "isError" | "isLoading" | "isSuccess" | "isFetched" | "isFetching" | "isRefetching" | "refetch" | "fetchStatus"> & {
+    isIdle: boolean;
+    status: "error" | "loading" | "success" | "idle";
+    internal: Pick<import("react-query").QueryObserverResult<unknown, unknown>, "isLoadingError" | "isRefetchError" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "isFetchedAfterMount" | "isPaused" | "isPlaceholderData" | "isPreviousData" | "isStale" | "remove">;
 };

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

@@ -14,4 +14,8 @@ export declare const queryKey: ({ addressOrName, chainId, formatUnits, token, }:
     readonly formatUnits: number | "wei" | "kwei" | "mwei" | "gwei" | "szabo" | "finney" | "ether" | undefined;
     readonly token: string | undefined;
 }];
-export declare function useBalance({ addressOrName, formatUnits, token, watch, cacheTime, enabled, keepPreviousData, select, staleTime, suspense, onError, onSettled, onSuccess, }?: UseBalanceArgs & UseBalanceConfig): import("react-query").UseQueryResult<FetchBalanceResult, Error>;
+export declare function useBalance({ addressOrName, cacheTime, chainId: chainId_, enabled, formatUnits, staleTime, suspense, token, watch, onError, onSettled, onSuccess, }?: UseBalanceArgs & UseBalanceConfig): Pick<import("react-query").QueryObserverResult<FetchBalanceResult, Error>, "data" | "error" | "isError" | "isLoading" | "isSuccess" | "isFetched" | "isFetching" | "isRefetching" | "refetch" | "fetchStatus"> & {
+    isIdle: boolean;
+    status: "error" | "loading" | "success" | "idle";
+    internal: Pick<import("react-query").QueryObserverResult<unknown, unknown>, "isLoadingError" | "isRefetchError" | "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "isFetchedAfterMount" | "isPaused" | "isPlaceholderData" | "isPreviousData" | "isStale" | "remove">;
+};

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

@@ -1,95 +1,39 @@
-import { ConnectResult, Connector } from '@wagmi/core';
+import { ConnectArgs, ConnectResult } from '@wagmi/core';
 import { UseMutationOptions } from 'react-query';
-declare type MutationOptions = UseMutationOptions<ConnectResult, Error, Connector>;
+export declare type UseConnectArgs = Partial<ConnectArgs>;
+declare type MutationOptions = UseMutationOptions<ConnectResult, Error, ConnectArgs>;
 export declare type UseConnectConfig = {
     /**
-     * Function fires before connect function and is passed same variables connect function would receive.
+     * Function to invoke before connect and is passed same variables connect function would receive.
      * Value returned from this function will be passed to both onError and onSettled functions in event of a mutation failure.
      */
     onBeforeConnect?: MutationOptions['onMutate'];
-    /** Function fires when connect is successful */
+    /** Function to invoke when connect is successful. */
     onConnect?: MutationOptions['onSuccess'];
-    /** Function fires if connect encounters error */
+    /** Function to invoke when an error is thrown while connecting. */
     onError?: MutationOptions['onError'];
-    /** Function fires when connect is either successful or encounters error */
+    /** Function to invoke when connect is settled (either successfully connected, or an error has thrown). */
     onSettled?: MutationOptions['onSettled'];
 };
-export declare const mutationKey = "connect";
-export declare function useConnect({ onBeforeConnect, onConnect, onError, onSettled, }?: UseConnectConfig): {
-    readonly activeConnector: Connector<any, any> | undefined;
-    readonly connect: import("react-query").UseMutateFunction<ConnectResult, Error, Connector<any, any>, unknown>;
-    readonly connectAsync: import("react-query").UseMutateAsyncFunction<ConnectResult, Error, Connector<any, any>, unknown>;
-    readonly connector: Connector<any, any> | undefined;
-    readonly connectors: Connector<any, any>[];
+export declare const mutationKey: (args: UseConnectArgs) => {
+    connector?: import("@wagmi/core").Connector<any, any> | undefined;
+    entity: string;
+}[];
+export declare function useConnect({ connector, onBeforeConnect, onConnect, onError, onSettled, }?: UseConnectArgs & UseConnectConfig): {
+    readonly activeConnector: import("@wagmi/core").Connector<any, any> | undefined;
+    readonly connect: (connector_?: import("@wagmi/core").Connector<any, any> | undefined) => void;
+    readonly connectAsync: (connector_?: import("@wagmi/core").Connector<any, any> | undefined) => Promise<ConnectResult<import("@ethersproject/providers").BaseProvider>>;
+    readonly connectors: import("@wagmi/core").Connector<any, any>[];
+    readonly data: ConnectResult<import("@ethersproject/providers").BaseProvider> | undefined;
+    readonly error: Error | null;
     readonly isConnected: boolean;
     readonly isConnecting: boolean;
     readonly isDisconnected: boolean;
+    readonly isError: boolean;
     readonly isIdle: boolean;
     readonly isReconnecting: boolean;
-    readonly status: "error" | "connecting" | "connected" | "reconnecting" | "disconnected" | "idle";
-    readonly data: undefined;
-    readonly error: null;
-    readonly isError: false;
+    readonly pendingConnector: import("@wagmi/core").Connector<any, any> | undefined;
     readonly reset: () => void;
-    readonly context: unknown;
-    readonly failureCount: number;
-    readonly isPaused: boolean;
-} | {
-    readonly activeConnector: Connector<any, any> | undefined;
-    readonly connect: import("react-query").UseMutateFunction<ConnectResult, Error, Connector<any, any>, unknown>;
-    readonly connectAsync: import("react-query").UseMutateAsyncFunction<ConnectResult, Error, Connector<any, any>, unknown>;
-    readonly connector: Connector<any, any> | undefined;
-    readonly connectors: Connector<any, any>[];
-    readonly isConnected: boolean;
-    readonly isConnecting: boolean;
-    readonly isDisconnected: boolean;
-    readonly isIdle: boolean;
-    readonly isReconnecting: boolean;
     readonly status: "error" | "connecting" | "connected" | "reconnecting" | "disconnected" | "idle";
-    readonly data: undefined;
-    readonly error: null;
-    readonly isError: false;
-    readonly reset: () => void;
-    readonly context: unknown;
-    readonly failureCount: number;
-    readonly isPaused: boolean;
-} | {
-    readonly activeConnector: Connector<any, any> | undefined;
-    readonly connect: import("react-query").UseMutateFunction<ConnectResult, Error, Connector<any, any>, unknown>;
-    readonly connectAsync: import("react-query").UseMutateAsyncFunction<ConnectResult, Error, Connector<any, any>, unknown>;
-    readonly connector: Connector<any, any> | undefined;
-    readonly connectors: Connector<any, any>[];
-    readonly isConnected: boolean;
-    readonly isConnecting: boolean;
-    readonly isDisconnected: boolean;
-    readonly isIdle: boolean;
-    readonly isReconnecting: boolean;
-    readonly status: "error" | "connecting" | "connected" | "reconnecting" | "disconnected" | "idle";
-    readonly data: undefined;
-    readonly error: Error;
-    readonly isError: true;
-    readonly reset: () => void;
-    readonly context: unknown;
-    readonly failureCount: number;
-    readonly isPaused: boolean;
-} | {
-    readonly activeConnector: Connector<any, any> | undefined;
-    readonly connect: import("react-query").UseMutateFunction<ConnectResult, Error, Connector<any, any>, unknown>;
-    readonly connectAsync: import("react-query").UseMutateAsyncFunction<ConnectResult, Error, Connector<any, any>, unknown>;
-    readonly connector: Connector<any, any> | undefined;
-    readonly connectors: Connector<any, any>[];
-    readonly isConnected: boolean;
-    readonly isConnecting: boolean;
-    readonly isDisconnected: boolean;
-    readonly isIdle: boolean;
-    readonly isReconnecting: boolean;
-    readonly status: "error" | "connecting" | "connected" | "reconnecting" | "disconnected" | "idle";
-    readonly data: ConnectResult;
-    readonly error: null;
-    readonly isError: false;
-    readonly reset: () => void;
-    readonly context: unknown;
-    readonly failureCount: number;
-    readonly isPaused: boolean;
 };
 export {};

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

@@ -0,0 +1,27 @@
+export declare type UseDisconnectConfig = {
+    /** Function to invoke when an error is thrown while connecting. */
+    onError?: (error: Error, context: unknown) => void | Promise<unknown>;
+    /**
+     * Function fires before mutation function and is passed same variables mutation function would receive.
+     * Value returned from this function will be passed to both onError and onSettled functions in event of a mutation failure.
+     */
+    onMutate?: () => unknown;
+    /** Function to invoke when connect is settled (either successfully connected, or an error has thrown). */
+    onSettled?: (error: Error | null, context: unknown) => void | Promise<unknown>;
+    /** Function fires when mutation is successful and will be passed the mutation's result */
+    onSuccess?: (context: unknown) => void | Promise<unknown>;
+};
+export declare const mutationKey: {
+    entity: string;
+}[];
+export declare function useDisconnect({ onError, onMutate, onSettled, onSuccess, }?: UseDisconnectConfig): {
+    readonly disconnect: import("react-query").UseMutateFunction<void, Error, void, unknown>;
+    readonly disconnectAsync: import("react-query").UseMutateAsyncFunction<void, Error, void, unknown>;
+    readonly error: Error | null;
+    readonly isError: boolean;
+    readonly isIdle: boolean;
+    readonly isLoading: boolean;
+    readonly isSuccess: boolean;
+    readonly reset: () => void;
+    readonly status: "error" | "loading" | "success" | "idle";
+};