wagmi 0.10.0 → 0.10.2

package/dist/index.d.ts

@@ -2,13 +2,14 @@ import * as _tanstack_react_query from '@tanstack/react-query';
 import { QueryClient, QueryKey, UseInfiniteQueryOptions, QueryFunction, InfiniteQueryObserverResult, UseMutationOptions, UseMutationResult, MutationFunction, MutationKey, UseQueryOptions, QueryObserverResult } from '@tanstack/react-query';
 import { Persister } from '@tanstack/react-query-persist-client';
 import * as _wagmi_core from '@wagmi/core';
-import { Provider, WebSocketProvider, ClientConfig, Client as Client$1, GetAccountResult, FetchBalanceResult, FetchBalanceArgs, ConnectArgs, ConnectResult, Signer, FetchSignerResult, FetchSignerArgs, SignMessageArgs, SignMessageResult, SignTypedDataArgs, SignTypedDataResult, SwitchNetworkArgs, SwitchNetworkResult, GetContractResult, GetContractArgs, ReadContractsResult, ReadContractsConfig, ReadContractResult, ReadContractConfig, WriteContractArgs, WriteContractResult, PrepareWriteContractResult, PrepareWriteContractConfig, FetchTokenResult, FetchTokenArgs, FetchEnsAddressArgs, FetchEnsAddressResult, FetchEnsAvatarArgs, FetchEnsAvatarResult, FetchEnsNameArgs, FetchEnsNameResult, FetchEnsResolverArgs, FetchEnsResolverResult, FetchBlockNumberArgs, FetchBlockNumberResult, FetchFeeDataResult, FetchFeeDataArgs, GetProviderArgs, GetWebSocketProviderArgs, PrepareSendTransactionResult, PrepareSendTransactionArgs, SendTransactionResult, SendTransactionArgs, SendTransactionPreparedRequest, SendTransactionUnpreparedRequest, FetchTransactionArgs, FetchTransactionResult, WaitForTransactionArgs, WaitForTransactionResult } from '@wagmi/core';
+import { Provider, WebSocketProvider, ClientConfig, Client as Client$1, GetAccountResult, FetchBalanceResult, FetchBalanceArgs, ConnectArgs, ConnectResult, Signer, FetchSignerResult, FetchSignerArgs, SignMessageArgs, SignMessageResult, SignTypedDataArgs, SignTypedDataResult, SwitchNetworkArgs, SwitchNetworkResult, GetContractResult, GetContractArgs, WatchContractEventConfig, ReadContractsResult, ReadContractsConfig, ReadContractResult, ReadContractConfig, WriteContractMode, WriteContractPreparedArgs, WriteContractUnpreparedArgs, WriteContractResult, WriteContractArgs, PrepareWriteContractResult, PrepareWriteContractConfig, FetchTokenResult, FetchTokenArgs, FetchEnsAddressArgs, FetchEnsAddressResult, FetchEnsAvatarArgs, FetchEnsAvatarResult, FetchEnsNameArgs, FetchEnsNameResult, FetchEnsResolverArgs, FetchEnsResolverResult, FetchBlockNumberArgs, FetchBlockNumberResult, FetchFeeDataResult, FetchFeeDataArgs, GetProviderArgs, GetWebSocketProviderArgs, PrepareSendTransactionResult, PrepareSendTransactionArgs, SendTransactionResult, SendTransactionArgs, SendTransactionPreparedRequest, SendTransactionUnpreparedRequest, FetchTransactionArgs, FetchTransactionResult, WaitForTransactionArgs, WaitForTransactionResult } from '@wagmi/core';
 export { AddChainError, Chain, ChainDoesNotSupportMulticallError, ChainMismatchError, ChainNotConfiguredError, ChainProviderFn, Connector, ConnectorAlreadyConnectedError, ConnectorData, ConnectorEvents, ConnectorNotFoundError, ContractMethodDoesNotExistError, ContractMethodNoResultError, ContractMethodRevertedError, ContractResultDecodeError, ProviderChainsNotFound, ProviderRpcError, ResourceUnavailableError, RpcError, Storage, SwitchChainError, SwitchChainNotSupportedError, Unit, UserRejectedRequestError, configureChains, createStorage, deepEqual, deserialize, erc20ABI, erc4626ABI, erc721ABI, goerli, mainnet, readContracts, serialize } from '@wagmi/core';
 import * as React from 'react';
-import { Address, TypedData, TypedDataToPrimitiveTypes, TypedDataDomain, ResolvedConfig, Abi, ExtractAbiEventNames, ExtractAbiEvent, AbiEvent, Narrow, AbiParametersToPrimitiveTypes } from 'abitype';
+import * as abitype from 'abitype';
+import { Address, TypedData, TypedDataToPrimitiveTypes, TypedDataDomain, ResolvedConfig, Abi, AbiEvent, ExtractAbiEvent, AbiParametersToPrimitiveTypes } from 'abitype';
 export { Address } from 'abitype';
 import { BigNumber, Transaction } from 'ethers';
-import { Optional, IsNever, Or, NotEqual, Event, ContractsConfig } from '@wagmi/core/internal';
+import { Contract, ContractsConfig } from '@wagmi/core/internal';
 import * as _ethersproject_providers from '@ethersproject/providers';
 
 type CreateClientConfig<TProvider extends Provider = Provider, TWebSocketProvider extends WebSocketProvider = WebSocketProvider> = ClientConfig<TProvider, TWebSocketProvider> & {
@@ -97,6 +98,13 @@ declare module 'ethers/lib/utils.js' {
         v?: number;
     } | ResolvedConfig['BytesType'] | string): string;
 }
+/**
+ * Makes {@link TKeys} optional in {@link TType} while preserving type inference.
+ */
+type PartialBy<TType, TKeys extends keyof TType> = Partial<Pick<TType, TKeys>> & Omit<TType, TKeys>;
+type DeepPartial<T, MaxDepth extends number, Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MaxDepth ? T : T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P], MaxDepth, [...Depth, 1]>;
+} : T;
 type QueryConfig<TData, TError, TSelectData = TData> = Pick<UseQueryOptions<TData, TError, TSelectData>, 'cacheTime' | 'enabled' | 'isDataEqual' | 'keepPreviousData' | 'select' | 'staleTime' | 'structuralSharing' | 'suspense' | 'onError' | 'onSettled' | 'onSuccess'> & {
     /** Scope the cache to a given context. */
     scopeKey?: string;
@@ -190,8 +198,12 @@ declare function useSignMessage({ message, onError, onMutate, onSettled, onSucce
     variables: SignMessageArgs | undefined;
 };
 
-type UseSignTypedDataArgs<TTypedData = unknown> = Optional<SignTypedDataArgs<TTypedData>, 'domain' | 'types' | 'value'>;
-type UseSignTypedDataConfig<TTypedData = unknown> = MutationConfig<SignTypedDataResult, Error, SignTypedDataArgs<TTypedData>> & UseSignTypedDataArgs<TTypedData>;
+type UseSignTypedDataArgs<TTypedData extends TypedData | {
+    [key: string]: unknown;
+} = TypedData> = PartialBy<SignTypedDataArgs<TTypedData>, 'domain' | 'types' | 'value'>;
+type UseSignTypedDataConfig<TTypedData extends TypedData | {
+    [key: string]: unknown;
+} = TypedData> = MutationConfig<SignTypedDataResult, Error, SignTypedDataArgs<TTypedData>> & UseSignTypedDataArgs<TTypedData>;
 declare function useSignTypedData<TTypedData extends TypedData>({ domain, types, value, onError, onMutate, onSettled, onSuccess, }?: UseSignTypedDataConfig<TTypedData>): {
     data: string | undefined;
     error: Error | null;
@@ -203,7 +215,13 @@ declare function useSignTypedData<TTypedData extends TypedData>({ domain, types,
     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" | "loading" | "idle";
-    variables: SignTypedDataArgs<TTypedData> | undefined;
+    variables: SignTypedDataArgs<TTypedData, TTypedData extends TypedData ? abitype.TypedDataToPrimitiveTypes<TTypedData> : {
+        [key: string]: any;
+    }, (TTypedData extends TypedData ? abitype.TypedDataToPrimitiveTypes<TTypedData> : {
+        [key: string]: any;
+    })[keyof (TTypedData extends TypedData ? abitype.TypedDataToPrimitiveTypes<TTypedData> : {
+        [key: string]: any;
+    })]> | undefined;
 };
 
 type UseSwitchNetworkArgs = Partial<SwitchNetworkArgs>;
@@ -232,43 +250,20 @@ type UseContractConfig<TAbi extends Abi | readonly unknown[] = Abi> = Partial<Pi
 };
 declare function useContract<TAbi extends Abi | readonly unknown[]>({ address, abi, signerOrProvider, }?: UseContractConfig<TAbi>): GetContractResult<TAbi> | null;
 
-type GetListener<TAbiEvent extends AbiEvent, TAbi = unknown> = AbiParametersToPrimitiveTypes<TAbiEvent['inputs']> extends infer TArgs extends readonly unknown[] ? Or<IsNever<TArgs>, NotEqual<TAbi, Abi>> extends true ? {
+type UseContractEventConfig<TAbi extends Abi | readonly unknown[] = Abi, TEventName extends string = string> = PartialBy<WatchContractEventConfig<TAbi, TEventName> & GetListener<TAbi, TEventName>, 'abi' | 'address' | 'eventName'>;
+declare function useContractEvent<TAbi extends Abi | readonly unknown[], TEventName extends string>({ address, chainId, abi, listener, eventName, once, }?: UseContractEventConfig<TAbi, TEventName>): void;
+type GetListener<TAbi extends Abi | readonly unknown[], TEventName extends string, TAbiEvent extends AbiEvent = TAbi extends Abi ? ExtractAbiEvent<TAbi, TEventName> : AbiEvent, TArgs = AbiParametersToPrimitiveTypes<TAbiEvent['inputs']>, FailedToParseArgs = ([TArgs] extends [never] ? true : false) | (readonly unknown[] extends TArgs ? true : false)> = true extends FailedToParseArgs ? {
     /**
      * 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;
+    listener: (...args: unknown[]) => void;
 } : {
-    /** Callback when event is emitted */
-    listener: (...args: [...args: TArgs, event: Event<TAbiEvent>]) => void;
-} : never;
-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;
-} & GetListener<TEvent, TAbi>;
-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;
-type UseContractEventConfig<TAbi = Abi, TEventName = string> = GetConfig<{
-    abi: TAbi;
-    eventName: TEventName;
-}>;
-declare function useContractEvent<TAbi extends Abi | readonly unknown[], TEventName extends string>({ address, chainId, abi, listener, eventName, once, }?: UseContractEventConfig<TAbi, TEventName>): void;
+    /** Callback when event is emitted */ listener: (...args: TArgs extends readonly unknown[] ? TArgs : unknown[]) => void;
+};
 
-type UseContractInfiniteReadsConfig<TContracts extends unknown[] = unknown[], TPageParam = unknown, TSelectData = ReadContractsResult<TContracts>> = Pick<ReadContractsConfig<TContracts>, 'allowFailure' | 'overrides'> & {
+type UseContractInfiniteReadsConfig<TContracts extends Contract[] = Contract[], TPageParam = unknown, TSelectData = ReadContractsResult<TContracts>> = Pick<ReadContractsConfig<TContracts>, 'allowFailure' | 'overrides'> & {
     cacheKey: string;
     contracts(pageParam: TPageParam): readonly [
         ...ContractsConfig<TContracts, {
@@ -293,12 +288,7 @@ declare function paginatedIndexesConfig<TAbi extends Abi | readonly unknown[], T
     getNextPageParam: InfiniteQueryConfig<unknown[], Error, TSelectData>['getNextPageParam'];
 };
 
-type UseContractReadConfig<TAbi = Abi, TFunctionName = string, TSelectData = ReadContractResult<TAbi, TFunctionName>> = ReadContractConfig<TAbi, TFunctionName, {
-    isAbiOptional: true;
-    isAddressOptional: true;
-    isArgsOptional: true;
-    isFunctionNameOptional: true;
-}> & QueryConfig<ReadContractResult<TAbi, TFunctionName>, Error, TSelectData> & {
+type UseContractReadConfig<TAbi extends Abi | readonly unknown[] = Abi, TFunctionName extends string = string, TSelectData = ReadContractResult<TAbi, TFunctionName>> = PartialBy<ReadContractConfig<TAbi, TFunctionName>, 'abi' | 'address' | 'args' | 'functionName'> & QueryConfig<ReadContractResult<TAbi, TFunctionName>, Error, TSelectData> & {
     /** If set to `true`, the cache will depend on the block number */
     cacheOnBlock?: boolean;
     /** Subscribe to changes */
@@ -306,13 +296,9 @@ type UseContractReadConfig<TAbi = Abi, TFunctionName = string, TSelectData = Rea
 };
 declare function useContractRead<TAbi extends Abi | readonly unknown[], TFunctionName extends string, TSelectData = ReadContractResult<TAbi, TFunctionName>>({ abi, address, args, cacheOnBlock, cacheTime, chainId: chainId_, enabled: enabled_, functionName, isDataEqual, onError, onSettled, onSuccess, overrides, scopeKey, select, staleTime, structuralSharing, suspense, watch, }?: UseContractReadConfig<TAbi, TFunctionName, TSelectData>): UseQueryResult<TSelectData, Error>;
 
-type UseContractReadsConfig<TContracts extends unknown[], TSelectData = ReadContractsResult<TContracts>> = ReadContractsConfig<TContracts, {
-    isAbiOptional: true;
-    isAddressOptional: true;
-    isArgsOptional: true;
-    isContractsOptional: true;
-    isFunctionNameOptional: true;
-}> & QueryConfig<ReadContractsResult<TContracts>, Error, TSelectData> & {
+type UseContractReadsConfig<TContracts extends Contract[], TSelectData = ReadContractsResult<TContracts>, Config = ReadContractsConfig<TContracts>> = {
+    [K in keyof Config]?: K extends 'contracts' ? DeepPartial<Config[K], 2> : Config[K];
+} & QueryConfig<ReadContractsResult<TContracts>, Error, TSelectData> & {
     /** If set to `true`, the cache will depend on the block number */
     cacheOnBlock?: boolean;
     /** Subscribe to changes */
@@ -323,14 +309,10 @@ declare function useContractReads<TAbi extends Abi | readonly unknown[], TFuncti
     functionName: TFunctionName;
 }[], TSelectData = ReadContractsResult<TContracts>>({ allowFailure, cacheOnBlock, cacheTime, contracts, enabled: enabled_, isDataEqual, keepPreviousData, onError, onSettled, onSuccess, overrides, scopeKey, select, staleTime, structuralSharing, suspense, watch, }?: UseContractReadsConfig<TContracts, TSelectData>): UseQueryResult<TSelectData, Error>;
 
-type UseContractWriteArgs<TAbi extends Abi | readonly unknown[] = Abi, TFunctionName extends string = string> = WriteContractArgs<TAbi, TFunctionName, {
-    isAbiOptional: true;
-    isAddressOptional: true;
-    isArgsOptional: true;
-    isFunctionNameOptional: true;
-    isRequestOptional: true;
-}>;
-type UseContractWriteConfig<TAbi extends Abi | readonly unknown[] = Abi, TFunctionName extends string = string> = MutationConfig<WriteContractResult, Error, UseContractWriteArgs> & UseContractWriteArgs<TAbi, TFunctionName>;
+type UseContractWriteArgs<TMode extends WriteContractMode = WriteContractMode, TAbi extends Abi | readonly unknown[] = Abi, TFunctionName extends string = string> = {
+    mode: TMode;
+} & (TMode extends 'prepared' ? PartialBy<WriteContractPreparedArgs<TAbi, TFunctionName>, 'abi' | 'address' | 'functionName' | 'request'> : PartialBy<WriteContractUnpreparedArgs<TAbi, TFunctionName>, 'abi' | 'address' | 'args' | 'functionName'>);
+type UseContractWriteConfig<TMode extends WriteContractMode = WriteContractMode, TAbi extends Abi | readonly unknown[] = Abi, TFunctionName extends string = string> = MutationConfig<WriteContractResult, Error, UseContractWriteArgs<TMode, TAbi, TFunctionName>> & UseContractWriteArgs<TMode, TAbi, TFunctionName>;
 type UseContractWriteMutationArgs<Mode extends 'prepared' | 'recklesslyUnprepared', TAbi extends Abi | readonly unknown[] = Abi, TFunctionName extends string = string> = Mode extends 'prepared' ? undefined : {
     /**
      * Recklessly pass through unprepared config. Note: This has
@@ -359,7 +341,7 @@ type UseContractWriteMutationArgs<Mode extends 'prepared' | 'recklesslyUnprepare
  * const { data, isLoading, isSuccess, write } = useContractWrite(config)
  *
  */
-declare function useContractWrite<TAbi extends Abi | readonly unknown[], TFunctionName extends string>({ address, args, chainId, abi, functionName, mode, overrides, request, onError, onMutate, onSettled, onSuccess, }?: UseContractWriteConfig<TAbi, TFunctionName>): {
+declare function useContractWrite<TMode extends WriteContractMode, TAbi extends Abi | readonly unknown[], TFunctionName extends string>({ address, args, chainId, abi, functionName, mode, overrides, request, onError, onMutate, onSettled, onSuccess, }?: UseContractWriteConfig<TMode, TAbi, TFunctionName>): {
     data: _wagmi_core.SendTransactionResult | undefined;
     error: Error | null;
     isError: boolean;
@@ -368,17 +350,12 @@ declare function useContractWrite<TAbi extends Abi | readonly unknown[], TFuncti
     isSuccess: boolean;
     reset: () => void;
     status: "error" | "success" | "loading" | "idle";
-    variables: UseContractWriteArgs<Abi, string> | undefined;
-    write: ((overrideConfig?: UseContractWriteMutationArgs<typeof mode, TAbi, TFunctionName>) => void) | undefined;
-    writeAsync: ((overrideConfig?: UseContractWriteMutationArgs<typeof mode, TAbi, TFunctionName>) => Promise<_wagmi_core.SendTransactionResult>) | undefined;
+    variables: UseContractWriteArgs<WriteContractMode, Abi, string> | undefined;
+    write: ((overrideConfig?: UseContractWriteMutationArgs<TMode & WriteContractPreparedArgs<TAbi, TFunctionName>["mode"], TAbi, TFunctionName> | UseContractWriteMutationArgs<TMode & WriteContractUnpreparedArgs<TAbi, TFunctionName>["mode"], TAbi, TFunctionName> | undefined) => void) | undefined;
+    writeAsync: ((overrideConfig?: UseContractWriteMutationArgs<TMode & WriteContractPreparedArgs<TAbi, TFunctionName>["mode"], TAbi, TFunctionName> | UseContractWriteMutationArgs<TMode & WriteContractUnpreparedArgs<TAbi, TFunctionName>["mode"], TAbi, TFunctionName> | undefined) => Promise<_wagmi_core.SendTransactionResult>) | undefined;
 };
 
-type UsePrepareContractWriteConfig<TAbi = Abi, TFunctionName extends string = string, TSigner extends Signer = Signer> = PrepareWriteContractConfig<TAbi, TFunctionName, TSigner, {
-    isAbiOptional: true;
-    isAddressOptional: true;
-    isArgsOptional: true;
-    isFunctionNameOptional: true;
-}> & QueryConfig<PrepareWriteContractResult<TAbi, TFunctionName>, Error>;
+type UsePrepareContractWriteConfig<TAbi extends Abi | readonly unknown[] = Abi, TFunctionName extends string = string, TSigner extends Signer = Signer> = PartialBy<PrepareWriteContractConfig<TAbi, TFunctionName, TSigner>, 'abi' | 'address' | 'args' | 'functionName'> & QueryConfig<PrepareWriteContractResult<TAbi, TFunctionName>, Error>;
 /**
  * @description Hook for preparing a contract write to be sent via [`useContractWrite`](/docs/hooks/useContractWrite).
  *

package/dist/index.js

@@ -846,11 +846,7 @@ function useSignMessage({
 // src/hooks/accounts/useSignTypedData.ts
 import { signTypedData } from "@wagmi/core";
 import * as React12 from "react";
-function mutationKey4({
-  domain,
-  types,
-  value
-}) {
+function mutationKey4({ domain, types, value }) {
   return [{ entity: "signTypedData", domain, types, value }];
 }
 function mutationFn4(args) {
@@ -1381,7 +1377,9 @@ function useContractReads({
   );
   const enabled = React18.useMemo(() => {
     let enabled2 = Boolean(
-      enabled_ && contracts?.every((x) => x.abi && x.address && x.functionName)
+      enabled_ && contracts?.every(
+        (x) => x.abi && x.address && x.functionName
+      )
     );
     if (cacheOnBlock)
       enabled2 = Boolean(enabled2 && blockNumber);

package/package.json

@@ -2,7 +2,7 @@
   "name": "wagmi",
   "description": "React Hooks for Ethereum",
   "license": "MIT",
-  "version": "0.10.0",
+  "version": "0.10.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/wagmi-dev/wagmi.git",
@@ -106,7 +106,7 @@
     "@walletconnect/ethereum-provider": "^1.8.0",
     "abitype": "^0.2.5",
     "use-sync-external-store": "^1.2.0",
-    "@wagmi/core": "0.8.7"
+    "@wagmi/core": "0.8.9"
   },
   "devDependencies": {
     "@testing-library/react": "^13.3.0",