wagmi 0.6.7 → 0.7.0

package/actions/dist/wagmi-actions.cjs.dev.js

@@ -74,6 +74,10 @@ Object.defineProperty(exports, 'getWebSocketProvider', {
   enumerable: true,
   get: function () { return core.getWebSocketProvider; }
 });
+Object.defineProperty(exports, 'multicall', {
+  enumerable: true,
+  get: function () { return core.multicall; }
+});
 Object.defineProperty(exports, 'prepareSendTransaction', {
   enumerable: true,
   get: function () { return core.prepareSendTransaction; }
@@ -122,6 +126,10 @@ Object.defineProperty(exports, 'watchContractEvent', {
   enumerable: true,
   get: function () { return core.watchContractEvent; }
 });
+Object.defineProperty(exports, 'watchMulticall', {
+  enumerable: true,
+  get: function () { return core.watchMulticall; }
+});
 Object.defineProperty(exports, 'watchNetwork', {
   enumerable: true,
   get: function () { return core.watchNetwork; }

package/actions/dist/wagmi-actions.cjs.prod.js

@@ -74,6 +74,10 @@ Object.defineProperty(exports, 'getWebSocketProvider', {
   enumerable: true,
   get: function () { return core.getWebSocketProvider; }
 });
+Object.defineProperty(exports, 'multicall', {
+  enumerable: true,
+  get: function () { return core.multicall; }
+});
 Object.defineProperty(exports, 'prepareSendTransaction', {
   enumerable: true,
   get: function () { return core.prepareSendTransaction; }
@@ -122,6 +126,10 @@ Object.defineProperty(exports, 'watchContractEvent', {
   enumerable: true,
   get: function () { return core.watchContractEvent; }
 });
+Object.defineProperty(exports, 'watchMulticall', {
+  enumerable: true,
+  get: function () { return core.watchMulticall; }
+});
 Object.defineProperty(exports, 'watchNetwork', {
   enumerable: true,
   get: function () { return core.watchNetwork; }

package/actions/dist/wagmi-actions.esm.js

@@ -1 +1 @@
-export { connect, disconnect, fetchBalance, fetchBlockNumber, fetchEnsAddress, fetchEnsAvatar, fetchEnsName, fetchEnsResolver, fetchFeeData, fetchSigner, fetchToken, fetchTransaction, getAccount, getContract, getNetwork, getProvider, getWebSocketProvider, prepareSendTransaction, prepareWriteContract, readContract, readContracts, sendTransaction, signMessage, signTypedData, switchNetwork, waitForTransaction, watchAccount, watchBlockNumber, watchContractEvent, watchNetwork, watchProvider, watchReadContract, watchReadContracts, watchSigner, watchWebSocketProvider, writeContract } from '@wagmi/core';
+export { connect, disconnect, fetchBalance, fetchBlockNumber, fetchEnsAddress, fetchEnsAvatar, fetchEnsName, fetchEnsResolver, fetchFeeData, fetchSigner, fetchToken, fetchTransaction, getAccount, getContract, getNetwork, getProvider, getWebSocketProvider, multicall, prepareSendTransaction, prepareWriteContract, readContract, readContracts, sendTransaction, signMessage, signTypedData, switchNetwork, waitForTransaction, watchAccount, watchBlockNumber, watchContractEvent, watchMulticall, watchNetwork, watchProvider, watchReadContract, watchReadContracts, watchSigner, watchWebSocketProvider, writeContract } from '@wagmi/core';

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

@@ -1,2 +1,2 @@
-export { connect, disconnect, fetchBalance, fetchBlockNumber, fetchEnsAddress, fetchEnsAvatar, fetchEnsName, fetchEnsResolver, fetchFeeData, fetchSigner, fetchToken, fetchTransaction, getAccount, getContract, getNetwork, getProvider, getWebSocketProvider, prepareSendTransaction, prepareWriteContract, readContract, readContracts, sendTransaction, signMessage, signTypedData, switchNetwork, waitForTransaction, watchAccount, watchBlockNumber, watchContractEvent, watchNetwork, watchProvider, watchReadContract, watchReadContracts, watchSigner, watchWebSocketProvider, writeContract, } from '@wagmi/core';
-export type { ConnectArgs, ConnectResult, FetchBalanceArgs, FetchBalanceResult, FetchBlockNumberArgs, FetchBlockNumberResult, FetchEnsAddressArgs, FetchEnsAddressResult, FetchEnsAvatarArgs, FetchEnsAvatarResult, FetchEnsNameArgs, FetchEnsNameResult, FetchEnsResolverArgs, FetchEnsResolverResult, FetchFeeDataArgs, FetchFeeDataResult, FetchSignerResult, FetchTokenArgs, FetchTokenResult, FetchTransactionArgs, FetchTransactionResult, GetAccountResult, GetContractArgs, GetNetworkResult, GetProviderArgs, GetProviderResult, GetWebSocketProviderArgs, GetWebSocketProviderResult, ReadContractConfig, ReadContractResult, ReadContractsConfig, ReadContractsResult, SendTransactionArgs, SendTransactionPreparedRequest, SendTransactionResult, SendTransactionUnpreparedRequest, SignMessageArgs, SignMessageResult, SignTypedDataArgs, SignTypedDataResult, SwitchNetworkArgs, SwitchNetworkResult, WaitForTransactionArgs, WaitForTransactionResult, WatchAccountCallback, WatchBlockNumberArgs, WatchBlockNumberCallback, WatchNetworkCallback, WatchReadContractConfig, WatchReadContractResult, WatchProviderCallback, WatchSignerCallback, WatchWebSocketProviderCallback, WriteContractArgs, WriteContractPreparedArgs, WriteContractResult, WriteContractUnpreparedArgs, } from '@wagmi/core';
+export { connect, disconnect, fetchBalance, fetchBlockNumber, fetchEnsAddress, fetchEnsAvatar, fetchEnsName, fetchEnsResolver, fetchFeeData, fetchSigner, fetchToken, fetchTransaction, getAccount, getContract, getNetwork, getProvider, getWebSocketProvider, multicall, prepareSendTransaction, prepareWriteContract, readContract, readContracts, sendTransaction, signMessage, signTypedData, switchNetwork, waitForTransaction, watchAccount, watchBlockNumber, watchContractEvent, watchMulticall, watchNetwork, watchProvider, watchReadContract, watchReadContracts, watchSigner, watchWebSocketProvider, writeContract, } from '@wagmi/core';
+export type { ConnectArgs, ConnectResult, FetchBalanceArgs, FetchBalanceResult, FetchBlockNumberArgs, FetchBlockNumberResult, FetchEnsAddressArgs, FetchEnsAddressResult, FetchEnsAvatarArgs, FetchEnsAvatarResult, FetchEnsNameArgs, FetchEnsNameResult, FetchEnsResolverArgs, FetchEnsResolverResult, FetchFeeDataArgs, FetchFeeDataResult, FetchSignerResult, FetchTokenArgs, FetchTokenResult, FetchTransactionArgs, FetchTransactionResult, GetAccountResult, GetContractArgs, GetContractResult, GetNetworkResult, GetProviderArgs, GetProviderResult, GetWebSocketProviderArgs, GetWebSocketProviderResult, MulticallConfig, MulticallResult, ReadContractConfig, ReadContractResult, ReadContractsConfig, ReadContractsResult, SendTransactionArgs, SendTransactionPreparedRequest, SendTransactionResult, SendTransactionUnpreparedRequest, SignMessageArgs, SignMessageResult, SignTypedDataArgs, SignTypedDataResult, SwitchNetworkArgs, SwitchNetworkResult, WaitForTransactionArgs, WaitForTransactionResult, WatchAccountCallback, WatchBlockNumberArgs, WatchBlockNumberCallback, WatchMulticallConfig, WatchMulticallCallback, WatchNetworkCallback, WatchReadContractConfig, WatchReadContractCallback, WatchReadContractsConfig, WatchReadContractsCallback, WatchProviderCallback, WatchSignerCallback, WatchWebSocketProviderCallback, WriteContractArgs, WriteContractPreparedArgs, WriteContractResult, WriteContractUnpreparedArgs, } from '@wagmi/core';

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

@@ -1,7 +1,9 @@
+import { QueryClient } from '@tanstack/react-query';
 import { Provider, WebSocketProvider } from '@wagmi/core';
 import * as React from 'react';
 import { Client } from './client';
 export declare const Context: React.Context<Client<Provider, WebSocketProvider> | undefined>;
+export declare const queryClientContext: React.Context<QueryClient | undefined>;
 export declare type WagmiConfigProps<TProvider extends Provider = Provider, TWebSocketProvider extends WebSocketProvider = WebSocketProvider> = {
     /** React-decorated Client instance */
     client: Client<TProvider, TWebSocketProvider>;

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

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

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

@@ -8,8 +8,8 @@ export declare const mutationKey: (args: UseConnectArgs) => readonly [{
     readonly entity: "connect";
 }];
 export declare function useConnect({ chainId, connector, onError, onMutate, onSettled, onSuccess, }?: UseConnectArgs & UseConnectConfig): {
-    readonly connect: (args?: Partial<ConnectArgs> | undefined) => void;
-    readonly connectAsync: (args?: Partial<ConnectArgs> | undefined) => Promise<ConnectResult<import("@wagmi/core").Provider>>;
+    readonly connect: (args?: Partial<ConnectArgs>) => void;
+    readonly connectAsync: (args?: Partial<ConnectArgs>) => Promise<ConnectResult<import("@wagmi/core").Provider>>;
     readonly connectors: import("@wagmi/core").Connector<any, any, any>[];
     readonly data: ConnectResult<import("@wagmi/core").Provider> | undefined;
     readonly error: Error | null;

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

@@ -3,19 +3,19 @@ import { MutationConfig } from '../../types';
 export declare type UseSignMessageArgs = Partial<SignMessageArgs>;
 export declare type UseSignMessageConfig = MutationConfig<SignMessageResult, Error, SignMessageArgs>;
 export declare const mutationKey: (args: UseSignMessageArgs) => readonly [{
-    readonly message?: string | import("ethers").Bytes | undefined;
+    readonly message?: string | Uint8Array | undefined;
     readonly entity: "signMessage";
 }];
 export declare function useSignMessage({ message, onError, onMutate, onSettled, onSuccess, }?: UseSignMessageArgs & UseSignMessageConfig): {
-    data: string | undefined;
+    data: `0x${string}` | undefined;
     error: Error | null;
     isError: boolean;
     isIdle: boolean;
     isLoading: boolean;
     isSuccess: boolean;
     reset: () => void;
-    signMessage: (args?: SignMessageArgs | undefined) => void;
-    signMessageAsync: (args?: SignMessageArgs | undefined) => Promise<string>;
+    signMessage: (args?: SignMessageArgs) => void;
+    signMessageAsync: (args?: SignMessageArgs) => Promise<`0x${string}`>;
     status: "error" | "success" | "idle" | "loading";
     variables: SignMessageArgs | undefined;
 };

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

@@ -1,23 +1,10 @@
 import { SignTypedDataArgs, SignTypedDataResult } from '@wagmi/core';
+import { Optional } from '@wagmi/core/internal';
+import { TypedData } from 'abitype';
 import { MutationConfig } from '../../types';
-export declare type UseSignTypedDataArgs = Partial<SignTypedDataArgs>;
-export declare type UseSignTypedDataConfig = MutationConfig<SignTypedDataResult, Error, SignTypedDataArgs>;
-export declare const mutationKey: (args: UseSignTypedDataArgs) => readonly [{
-    readonly domain?: {
-        name?: string | undefined;
-        version?: string | undefined;
-        chainId?: string | number | bigint | undefined;
-        verifyingContract?: string | undefined;
-        salt?: import("ethers").BytesLike | undefined;
-    } | undefined;
-    readonly types?: Record<string, {
-        name: string;
-        type: string;
-    }[]> | undefined;
-    readonly value?: Record<string, any> | undefined;
-    readonly entity: "signTypedData";
-}];
-export declare function useSignTypedData({ domain, types, value, onError, onMutate, onSettled, onSuccess, }?: UseSignTypedDataArgs & UseSignTypedDataConfig): {
+export declare type UseSignTypedDataArgs<TTypedData = unknown> = Optional<SignTypedDataArgs<TTypedData>, 'domain' | 'types' | 'value'>;
+export declare type UseSignTypedDataConfig<TTypedData = unknown> = MutationConfig<SignTypedDataResult, Error, SignTypedDataArgs<TTypedData>> & UseSignTypedDataArgs<TTypedData>;
+export declare function useSignTypedData<TTypedData extends TypedData>({ domain, types, value, onError, onMutate, onSettled, onSuccess, }?: UseSignTypedDataConfig<TTypedData>): {
     data: string | undefined;
     error: Error | null;
     isError: boolean;
@@ -25,8 +12,8 @@ export declare function useSignTypedData({ domain, types, value, onError, onMuta
     isLoading: boolean;
     isSuccess: boolean;
     reset: () => void;
-    signTypedData: (args?: SignTypedDataArgs | undefined) => void;
-    signTypedDataAsync: (args?: SignTypedDataArgs | undefined) => Promise<string>;
+    signTypedData: <TTypedDataMutate extends TypedData = TTypedData>(args?: UseSignTypedDataArgs<TTypedDataMutate> | undefined) => void;
+    signTypedDataAsync: <TTypedDataMutate_1 extends TypedData = TTypedData>(args?: UseSignTypedDataArgs<TTypedDataMutate_1> | undefined) => Promise<string>;
     status: "error" | "success" | "idle" | "loading";
-    variables: SignTypedDataArgs | undefined;
+    variables: SignTypedDataArgs<TTypedData> | undefined;
 };

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

@@ -1,11 +1,9 @@
-import { FetchSignerResult, Signer } from '@wagmi/core';
+import { FetchSignerArgs, FetchSignerResult, Signer } from '@wagmi/core';
 import { QueryConfig } from '../../types';
-export declare type UseSignerConfig = Omit<QueryConfig<FetchSignerResult, Error>, 'cacheTime' | 'staleTime' | 'enabled'>;
-export declare const queryKey: () => readonly [{
+export declare type UseSignerConfig = Omit<QueryConfig<FetchSignerResult, Error>, 'cacheTime' | 'staleTime' | 'enabled'> & FetchSignerArgs;
+export declare const queryKey: ({ chainId }: FetchSignerArgs) => readonly [{
     readonly entity: "signer";
+    readonly chainId: number | undefined;
+    readonly persist: false;
 }];
-export declare function useSigner<TSigner extends Signer>({ suspense, onError, onSettled, onSuccess, }?: UseSignerConfig): Pick<import("@tanstack/react-query").QueryObserverResult<FetchSignerResult<TSigner>, Error>, "error" | "data" | "fetchStatus" | "isError" | "isFetched" | "isFetching" | "isLoading" | "isRefetching" | "isSuccess" | "refetch"> & {
-    isIdle: boolean;
-    status: "error" | "success" | "idle" | "loading";
-    internal: Pick<import("@tanstack/react-query").QueryObserverResult<unknown, unknown>, "dataUpdatedAt" | "errorUpdatedAt" | "failureCount" | "isFetchedAfterMount" | "isLoadingError" | "isPaused" | "isPlaceholderData" | "isPreviousData" | "isRefetchError" | "isStale" | "remove">;
-};
+export declare function useSigner<TSigner extends Signer>({ chainId: chainId_, suspense, onError, onSettled, onSuccess, }?: UseSignerConfig): import("../utils/query/useQuery").UseQueryResult<FetchSignerResult<TSigner>, Error>;

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

@@ -19,7 +19,7 @@ export declare function useSwitchNetwork({ chainId, throwForSwitchChainNotSuppor
     readonly pendingChainId: number | undefined;
     readonly reset: () => void;
     readonly status: "error" | "success" | "idle" | "loading";
-    readonly switchNetwork: ((chainId_?: number | undefined) => void) | undefined;
-    readonly switchNetworkAsync: ((chainId_?: number | undefined) => Promise<import("@wagmi/core").Chain>) | undefined;
+    readonly switchNetwork: ((chainId_?: SwitchNetworkArgs['chainId']) => void) | undefined;
+    readonly switchNetworkAsync: ((chainId_?: SwitchNetworkArgs['chainId']) => Promise<import("@wagmi/core").Chain>) | undefined;
     readonly variables: SwitchNetworkArgs | undefined;
 };

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

@@ -4,6 +4,5 @@ export { useContractInfiniteReads, paginatedIndexesConfig, } from './useContract
 export { useContractRead } from './useContractRead';
 export { useContractReads } from './useContractReads';
 export { useContractWrite } from './useContractWrite';
-export { useDeprecatedContractWrite } from './useDeprecatedContractWrite';
 export { usePrepareContractWrite } from './usePrepareContractWrite';
 export { useToken } from './useToken';

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

@@ -1,3 +1,7 @@
-import { GetContractArgs } from '@wagmi/core';
-export declare type UseContractConfig = GetContractArgs;
-export declare const useContract: <Contract = any>({ addressOrName, contractInterface, signerOrProvider, }: UseContractConfig) => Contract;
+import { GetContractArgs, GetContractResult } from '@wagmi/core';
+import { Abi } from 'abitype';
+export declare type UseContractConfig<TAbi extends Abi | readonly unknown[] = Abi> = Partial<Pick<GetContractArgs<TAbi>, 'abi' | 'address'>> & {
+    /** Signer or provider to attach to contract */
+    signerOrProvider?: GetContractArgs['signerOrProvider'] | null;
+};
+export declare function useContract<TAbi extends Abi | readonly unknown[]>({ address, abi, signerOrProvider, }?: UseContractConfig<TAbi>): GetContractResult<TAbi> | null;

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

@@ -1,13 +1,38 @@
-import { ethers } from 'ethers';
-import { UseContractConfig } from './useContract';
-export declare type UseContractEventConfig<Contract extends ethers.Contract = ethers.Contract> = UseContractConfig & {
-    /** Event name to listen to */
-    eventName: Parameters<Contract['on']>[0];
-    /** Callback function when event is called */
-    listener: Parameters<Contract['on']>[1];
+import { AbiEventParametersToPrimitiveTypes, Event, IsNever, NotEqual, Or } from '@wagmi/core/internal';
+import { Abi, AbiEvent, ExtractAbiEvent, ExtractAbiEventNames, Narrow } from 'abitype';
+declare type GetListener<TAbiEvent extends AbiEvent, TAbi = unknown> = AbiEventParametersToPrimitiveTypes<TAbiEvent['inputs']> extends infer TArgs extends readonly unknown[] ? Or<IsNever<TArgs>, NotEqual<TAbi, Abi>> extends true ? {
+    /**
+     * Callback when event is emitted
+     *
+     * Use a [const assertion](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#const-assertions) on {@link abi} for type inference.
+     */
+    listener: (...args: any) => void;
+} : {
+    /** Callback when event is emitted */
+    listener: (...args: [...args: TArgs, event: Event<TAbiEvent>]) => void;
+} : never;
+declare type ContractEventConfig<TAbi extends Abi | readonly unknown[] = Abi, TEventName extends string = string, TEvent extends AbiEvent = TAbi extends Abi ? ExtractAbiEvent<TAbi, TEventName> : never> = {
+    /** Contract address */
+    address?: string;
+    /** Contract ABI */
+    abi?: Narrow<TAbi>;
     /** Chain id to use for provider */
     chainId?: number;
+    /** Event to listen for */
+    eventName?: IsNever<TEventName> extends true ? string : TEventName;
     /** Receive only a single event */
     once?: boolean;
-};
-export declare const useContractEvent: <Contract extends ethers.Contract>({ addressOrName, chainId, contractInterface, listener, eventName, signerOrProvider, once, }: UseContractEventConfig<Contract>) => void;
+} & GetListener<TEvent, TAbi>;
+declare type GetConfig<T> = T extends {
+    abi: infer TAbi extends Abi;
+    eventName: infer TEventName extends string;
+} ? ContractEventConfig<TAbi, ExtractAbiEventNames<TAbi>, ExtractAbiEvent<TAbi, TEventName>> : T extends {
+    abi: infer TAbi extends readonly unknown[];
+    eventName: infer TEventName extends string;
+} ? ContractEventConfig<TAbi, TEventName> : ContractEventConfig;
+export declare type UseContractEventConfig<TAbi = Abi, TEventName = string> = GetConfig<{
+    abi: TAbi;
+    eventName: TEventName;
+}>;
+export declare function useContractEvent<TAbi extends Abi | readonly unknown[], TEventName extends string>({ address, chainId, abi, listener, eventName, once, }?: UseContractEventConfig<TAbi, TEventName>): void;
+export {};