wagmi 1.4.1 → 2.0.0

package/src/hooks/useWaitForTransactionReceipt.ts

@@ -0,0 +1,74 @@
+'use client'
+
+import type {
+  Config,
+  ResolvedRegister,
+  WaitForTransactionReceiptError,
+} from '@wagmi/core'
+import { type Evaluate } from '@wagmi/core/internal'
+import {
+  type WaitForTransactionReceiptData,
+  type WaitForTransactionReceiptOptions,
+  type WaitForTransactionReceiptQueryFnData,
+  type WaitForTransactionReceiptQueryKey,
+  waitForTransactionReceiptQueryOptions,
+} from '@wagmi/core/query'
+
+import type { ConfigParameter } from '../types/properties.js'
+import {
+  type UseQueryParameters,
+  type UseQueryReturnType,
+  useQuery,
+} from '../utils/query.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseWaitForTransactionReceiptParameters<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = WaitForTransactionReceiptData<config, chainId>,
+> = Evaluate<
+  WaitForTransactionReceiptOptions<config, chainId> &
+    ConfigParameter<config> & {
+      query?:
+        | UseQueryParameters<
+            WaitForTransactionReceiptQueryFnData<config, chainId>,
+            WaitForTransactionReceiptError,
+            selectData,
+            WaitForTransactionReceiptQueryKey<config, chainId>
+          >
+        | undefined
+    }
+>
+
+export type UseWaitForTransactionReceiptReturnType<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = WaitForTransactionReceiptData<config, chainId>,
+> = UseQueryReturnType<selectData, WaitForTransactionReceiptError>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useWaitForTransactionReceipt */
+export function useWaitForTransactionReceipt<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = WaitForTransactionReceiptData<config, chainId>,
+>(
+  parameters: UseWaitForTransactionReceiptParameters<
+    config,
+    chainId,
+    selectData
+  > = {},
+): UseWaitForTransactionReceiptReturnType<config, chainId, selectData> {
+  const { hash, query = {} } = parameters
+
+  const config = useConfig(parameters)
+  const chainId = useChainId()
+
+  const queryOptions = waitForTransactionReceiptQueryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+  })
+  const enabled = Boolean(!hash && (query.enabled ?? true))
+
+  return useQuery({ ...queryOptions, ...query, enabled })
+}

package/src/hooks/useWalletClient.ts

@@ -0,0 +1,96 @@
+'use client'
+
+// Almost identical implementation to `useConnectorClient` (except for return type)
+// Should update both in tandem
+
+import { useQueryClient } from '@tanstack/react-query'
+import type {
+  Config,
+  GetWalletClientError,
+  ResolvedRegister,
+} from '@wagmi/core'
+import { type Evaluate, type Omit } from '@wagmi/core/internal'
+import {
+  type GetWalletClientData,
+  type GetWalletClientOptions,
+  type GetWalletClientQueryFnData,
+  type GetWalletClientQueryKey,
+  getWalletClientQueryOptions,
+} from '@wagmi/core/query'
+import { useEffect } from 'react'
+
+import type { ConfigParameter } from '../types/properties.js'
+import {
+  type UseQueryParameters,
+  type UseQueryReturnType,
+  useQuery,
+} from '../utils/query.js'
+import { useAccount } from './useAccount.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseWalletClientParameters<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetWalletClientData<config, chainId>,
+> = Evaluate<
+  GetWalletClientOptions<config, chainId> &
+    ConfigParameter<config> & {
+      query?: Evaluate<
+        Omit<
+          UseQueryParameters<
+            GetWalletClientQueryFnData<config, chainId>,
+            GetWalletClientError,
+            selectData,
+            GetWalletClientQueryKey<config, chainId>
+          >,
+          'gcTime' | 'staleTime'
+        >
+      >
+    }
+>
+
+export type UseWalletClientReturnType<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetWalletClientData<config, chainId>,
+> = UseQueryReturnType<selectData, GetWalletClientError>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useWalletClient */
+export function useWalletClient<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+  selectData = GetWalletClientData<config, chainId>,
+>(
+  parameters: UseWalletClientParameters<config, chainId, selectData> = {},
+): UseWalletClientReturnType<config, chainId, selectData> {
+  const { query = {}, ...rest } = parameters
+
+  const config = useConfig(rest)
+  const queryClient = useQueryClient()
+  const { address, connector, status } = useAccount()
+  const chainId = useChainId()
+
+  const { queryKey, ...options } = getWalletClientQueryOptions(config, {
+    ...parameters,
+    chainId: parameters.chainId ?? chainId,
+    connector: parameters.connector ?? connector,
+  })
+  const enabled = Boolean(status !== 'disconnected' && (query.enabled ?? true))
+
+  // biome-ignore lint/nursery/useExhaustiveDependencies: `queryKey` not required
+  useEffect(() => {
+    // invalidate when address changes
+    if (address) queryClient.invalidateQueries({ queryKey })
+    else queryClient.removeQueries({ queryKey }) // remove when account is disconnected
+  }, [address, queryClient])
+
+  return useQuery({
+    ...options,
+    ...query,
+    queryKey,
+    enabled,
+    gcTime: 0,
+    staleTime: Infinity,
+  })
+}

package/src/hooks/useWatchBlockNumber.ts

@@ -0,0 +1,49 @@
+'use client'
+
+import {
+  type Config,
+  type ResolvedRegister,
+  type WatchBlockNumberParameters,
+  watchBlockNumber,
+} from '@wagmi/core'
+import { type UnionEvaluate, type UnionPartial } from '@wagmi/core/internal'
+import { useEffect } from 'react'
+
+import type { ConfigParameter, EnabledParameter } from '../types/properties.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseWatchBlockNumberParameters<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+> = UnionEvaluate<
+  UnionPartial<WatchBlockNumberParameters<config, chainId>> &
+    ConfigParameter<config> &
+    EnabledParameter
+>
+
+export type UseWatchBlockNumberReturnType = void
+
+/** https://alpha.wagmi.sh/react/api/hooks/useWatchBlockNumber */
+export function useWatchBlockNumber<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+>(
+  parameters: UseWatchBlockNumberParameters<config, chainId> = {} as any,
+): UseWatchBlockNumberReturnType {
+  const { enabled = true, onBlockNumber, config: _, ...rest } = parameters
+
+  const config = useConfig(parameters)
+  const configChainId = useChainId()
+  const chainId = parameters.chainId ?? configChainId
+
+  useEffect(() => {
+    if (!enabled) return
+    if (!onBlockNumber) return
+    return watchBlockNumber(config, {
+      ...(rest as any),
+      chainId,
+      onBlockNumber,
+    })
+  }, [chainId, config, enabled, onBlockNumber, rest])
+}

package/src/hooks/useWatchContractEvent.ts

@@ -0,0 +1,64 @@
+'use client'
+
+import {
+  type Config,
+  type ResolvedRegister,
+  type WatchContractEventParameters,
+  watchContractEvent,
+} from '@wagmi/core'
+import { type UnionEvaluate, type UnionPartial } from '@wagmi/core/internal'
+import { useEffect } from 'react'
+
+import type { Abi, ContractEventName } from 'viem'
+import type { ConfigParameter, EnabledParameter } from '../types/properties.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseWatchContractEventParameters<
+  abi extends Abi | readonly unknown[] = Abi,
+  eventName extends ContractEventName<abi> = ContractEventName<abi>,
+  strict extends boolean | undefined = undefined,
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+> = UnionEvaluate<
+  UnionPartial<
+    WatchContractEventParameters<abi, eventName, strict, config, chainId>
+  > &
+    ConfigParameter<config> &
+    EnabledParameter
+>
+
+export type UseWatchContractEventReturnType = void
+
+/** https://alpha.wagmi.sh/react/api/hooks/useWatchContractEvent */
+export function useWatchContractEvent<
+  const abi extends Abi | readonly unknown[],
+  eventName extends ContractEventName<abi>,
+  strict extends boolean | undefined = undefined,
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+>(
+  parameters: UseWatchContractEventParameters<
+    abi,
+    eventName,
+    strict,
+    config,
+    chainId
+  > = {} as any,
+): UseWatchContractEventReturnType {
+  const { enabled = true, onLogs, config: _, ...rest } = parameters
+
+  const config = useConfig(parameters)
+  const configChainId = useChainId()
+  const chainId = parameters.chainId ?? configChainId
+
+  useEffect(() => {
+    if (!enabled) return
+    if (!onLogs) return
+    return watchContractEvent(config, {
+      ...(rest as any),
+      chainId,
+      onLogs,
+    })
+  }, [chainId, config, enabled, rest, onLogs])
+}

package/src/hooks/useWatchPendingTransactions.ts

@@ -0,0 +1,52 @@
+'use client'
+
+import {
+  type Config,
+  type ResolvedRegister,
+  type WatchPendingTransactionsParameters,
+  watchPendingTransactions,
+} from '@wagmi/core'
+import { type UnionEvaluate, type UnionPartial } from '@wagmi/core/internal'
+import { useEffect } from 'react'
+
+import type { ConfigParameter, EnabledParameter } from '../types/properties.js'
+import { useChainId } from './useChainId.js'
+import { useConfig } from './useConfig.js'
+
+export type UseWatchPendingTransactionsParameters<
+  config extends Config = Config,
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+> = UnionEvaluate<
+  UnionPartial<WatchPendingTransactionsParameters<config, chainId>> &
+    ConfigParameter<config> &
+    EnabledParameter
+>
+
+export type UseWatchPendingTransactionsReturnType = void
+
+/** https://alpha.wagmi.sh/react/api/hooks/useWatchPendingTransactions */
+export function useWatchPendingTransactions<
+  config extends Config = ResolvedRegister['config'],
+  chainId extends config['chains'][number]['id'] = config['chains'][number]['id'],
+>(
+  parameters: UseWatchPendingTransactionsParameters<
+    config,
+    chainId
+  > = {} as any,
+): UseWatchPendingTransactionsReturnType {
+  const { enabled = true, onTransactions, config: _, ...rest } = parameters
+
+  const config = useConfig(parameters)
+  const configChainId = useChainId()
+  const chainId = parameters.chainId ?? configChainId
+
+  useEffect(() => {
+    if (!enabled) return
+    if (!onTransactions) return
+    return watchPendingTransactions(config, {
+      ...(rest as any),
+      chainId,
+      onTransactions,
+    })
+  }, [chainId, config, enabled, onTransactions, rest])
+}

package/src/types/properties.ts

@@ -0,0 +1,9 @@
+import type { Config } from '@wagmi/core'
+
+export type EnabledParameter = {
+  enabled?: boolean | undefined
+}
+
+export type ConfigParameter<config extends Config = Config> = {
+  config?: Config | config | undefined
+}

package/src/utils/getVersion.ts

@@ -0,0 +1,3 @@
+import { version } from '../version.js'
+
+export const getVersion = () => `wagmi@${version}`

package/src/utils/query.ts

@@ -0,0 +1,102 @@
+import {
+  type DefaultError,
+  type QueryKey,
+  type UseMutationOptions,
+  type UseMutationResult,
+  type UseQueryOptions,
+  type UseQueryResult,
+  replaceEqualDeep,
+  useQuery as tanstack_useQuery,
+} from '@tanstack/react-query'
+import {
+  type Evaluate,
+  type ExactPartial,
+  type Omit,
+  deepEqual,
+} from '@wagmi/core/internal'
+import { hashFn } from '@wagmi/core/query'
+
+export type UseMutationParameters<
+  data = unknown,
+  error = Error,
+  variables = void,
+  context = unknown,
+> = Evaluate<
+  Omit<
+    UseMutationOptions<data, error, Evaluate<variables>, context>,
+    'mutationFn' | 'mutationKey' | 'throwOnError'
+  >
+>
+
+export type UseMutationReturnType<
+  data = unknown,
+  error = Error,
+  variables = void,
+  context = unknown,
+> = Evaluate<
+  Omit<
+    UseMutationResult<data, error, variables, context>,
+    'mutate' | 'mutateAsync'
+  >
+>
+
+////////////////////////////////////////////////////////////////////////////////
+
+export type UseQueryParameters<
+  queryFnData = unknown,
+  error = DefaultError,
+  data = queryFnData,
+  queryKey extends QueryKey = QueryKey,
+> = Evaluate<
+  ExactPartial<
+    Omit<
+      UseQueryOptions<queryFnData, error, data, queryKey>,
+      | 'initialData'
+      | 'queryFn'
+      | 'queryHash'
+      | 'queryKey'
+      | 'queryKeyHashFn'
+      | 'throwOnError'
+    >
+  > & {
+    // Fix `initialData` type
+    initialData?: UseQueryOptions<
+      queryFnData,
+      error,
+      data,
+      queryKey
+    >['initialData']
+  }
+>
+
+export type UseQueryReturnType<data = unknown, error = DefaultError> = Evaluate<
+  UseQueryResult<data, error> & {
+    queryKey: QueryKey
+  }
+>
+
+// Adding some basic customization.
+// Ideally we don't have this function, but `import('@tanstack/react-query').useQuery` currently has some quirks where it is super hard to
+// pass down the inferred `initialData` type because of it's discriminated overload in the on `useQuery`.
+export function useQuery<queryFnData, error, data, queryKey extends QueryKey>(
+  parameters: UseQueryParameters<queryFnData, error, data, queryKey> & {
+    queryKey: QueryKey
+  },
+): UseQueryReturnType<data, error> {
+  const result = tanstack_useQuery({
+    ...(parameters as any),
+    queryKeyHashFn: hashFn, // for bigint support
+  }) as UseQueryReturnType<data, error>
+  result.queryKey = parameters.queryKey
+  return result
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
+export function structuralSharing<data>(
+  oldData: data | undefined,
+  newData: data,
+): data {
+  if (deepEqual(oldData, newData)) return oldData as data
+  return replaceEqualDeep(oldData, newData)
+}

package/src/version.ts

@@ -0,0 +1 @@
+export const version = '2.0.0'

package/README.md

@@ -1,30 +0,0 @@
-# wagmi
-
-## Documentation
-
-For full documentation and examples, visit [wagmi.sh](https://wagmi.sh).
-
-## Installation
-
-Install wagmi and its [viem](https://viem.sh) peer dependency.
-
-```bash
-npm install wagmi viem
-```
-
-## Community
-
-Check out the following places for more wagmi-related content:
-
-- Join the [discussions on GitHub](https://github.com/wagmi-dev/wagmi/discussions)
-- Follow [@wagmi_sh](https://twitter.com/wagmi_sh) on Twitter for project updates
-- Share [your project/organization](https://github.com/wagmi-dev/wagmi/discussions/201) using wagmi
-- Browse the [awesome-wagmi](https://github.com/wagmi-dev/awesome-wagmi) list of awesome projects and resources
-
-## Support
-
-If you find wagmi useful, please consider supporting development. Thank you 🙏
-
-- [GitHub Sponsors](https://github.com/sponsors/wagmi-dev?metadata_campaign=readme_wagmi)
-- [Gitcoin Grant](https://wagmi.sh/gitcoin)
-- [wagmi-dev.eth](https://etherscan.io/enslookup-search?search=wagmi-dev.eth)

package/actions/package.json

@@ -1,4 +0,0 @@
-{
-  "type": "module",
-  "main": "../dist/actions.js"
-}

package/chains/package.json

@@ -1,4 +0,0 @@
-{
-  "type": "module",
-  "main": "../dist/chains.js"
-}

package/connectors/coinbaseWallet/package.json

@@ -1,4 +0,0 @@
-{
-  "type": "module",
-  "main": "../../dist/connectors/coinbaseWallet.js"
-}

package/connectors/injected/package.json

@@ -1,4 +0,0 @@
-{
-  "type": "module",
-  "main": "../../dist/connectors/injected.js"
-}

package/connectors/ledger/package.json

@@ -1,4 +0,0 @@
-{
-  "type": "module",
-  "main": "../../dist/connectors/ledger.js"
-}

package/connectors/metaMask/package.json

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

package/connectors/mock/package.json

@@ -1,4 +0,0 @@
-{
-  "type": "module",
-  "main": "../../dist/connectors/mock.js"
-}

package/connectors/package.json

@@ -1,4 +0,0 @@
-{
-  "type": "module",
-  "main": "../dist/connectors/index.js"
-}

package/connectors/safe/package.json

@@ -1,4 +0,0 @@
-{
-  "type": "module",
-  "main": "../../dist/connectors/safe.js"
-}

package/connectors/walletConnect/package.json

@@ -1,4 +0,0 @@
-{
-  "type": "module",
-  "main": "../../dist/connectors/walletConnect.js"
-}

package/connectors/walletConnectLegacy/package.json

@@ -1,4 +0,0 @@
-{
-  "type": "module",
-  "main": "../../dist/connectors/walletConnectLegacy.js"
-}

package/dist/actions.d.ts

@@ -1 +0,0 @@
-export { ConnectArgs, ConnectResult, FetchBalanceArgs, FetchBalanceResult, FetchBlockNumberArgs, FetchBlockNumberResult, FetchEnsAddressArgs, FetchEnsAddressResult, FetchEnsAvatarArgs, FetchEnsAvatarResult, FetchEnsNameArgs, FetchEnsNameResult, FetchEnsResolverArgs, FetchEnsResolverResult, FetchFeeDataArgs, FetchFeeDataResult, FetchTokenArgs, FetchTokenResult, FetchTransactionArgs, FetchTransactionResult, GetAccountResult, GetContractArgs, GetContractResult, GetNetworkResult, GetPublicClientArgs, GetPublicClientResult, GetWalletClientArgs, GetWalletClientResult, GetWebSocketPublicClientArgs, GetWebSocketPublicClientResult, MulticallConfig, MulticallResult, PrepareWriteContractConfig, PrepareWriteContractResult, ReadContractConfig, ReadContractResult, ReadContractsConfig, ReadContractsResult, SendTransactionArgs, SendTransactionResult, SignMessageArgs, SignMessageResult, SignTypedDataArgs, SignTypedDataResult, SwitchNetworkArgs, SwitchNetworkResult, WaitForTransactionArgs, WaitForTransactionResult, WatchAccountCallback, WatchBlockNumberArgs, WatchBlockNumberCallback, WatchContractEventCallback, WatchContractEventConfig, WatchMulticallCallback, WatchMulticallConfig, WatchNetworkCallback, WatchPendingTransactionsArgs, WatchPendingTransactionsCallback, WatchPendingTransactionsResult, WatchPublicClientCallback, WatchReadContractCallback, WatchReadContractConfig, WatchReadContractsCallback, WatchReadContractsConfig, WatchWalletClientArgs, WatchWalletClientCallback, WatchWebSocketPublicClientCallback, WriteContractArgs, WriteContractMode, WriteContractPreparedArgs, WriteContractResult, WriteContractUnpreparedArgs, connect, disconnect, fetchBalance, fetchBlockNumber, fetchEnsAddress, fetchEnsAvatar, fetchEnsName, fetchEnsResolver, fetchFeeData, fetchToken, fetchTransaction, getAccount, getContract, getNetwork, getPublicClient, getWalletClient, getWebSocketPublicClient, multicall, prepareSendTransaction, prepareWriteContract, readContract, readContracts, sendTransaction, signMessage, signTypedData, switchNetwork, waitForTransaction, watchAccount, watchBlockNumber, watchContractEvent, watchMulticall, watchNetwork, watchPendingTransactions, watchPublicClient, watchReadContract, watchReadContracts, watchWalletClient, watchWebSocketPublicClient, writeContract } from '@wagmi/core';

package/dist/actions.js

@@ -1,85 +0,0 @@
-"use client";
-
-// src/actions.ts
-import {
-  connect,
-  disconnect,
-  fetchBalance,
-  fetchBlockNumber,
-  fetchEnsAddress,
-  fetchEnsAvatar,
-  fetchEnsName,
-  fetchEnsResolver,
-  fetchFeeData,
-  fetchToken,
-  fetchTransaction,
-  getAccount,
-  getContract,
-  getNetwork,
-  getPublicClient,
-  getWalletClient,
-  getWebSocketPublicClient,
-  multicall,
-  prepareSendTransaction,
-  prepareWriteContract,
-  readContract,
-  readContracts,
-  sendTransaction,
-  signMessage,
-  signTypedData,
-  switchNetwork,
-  waitForTransaction,
-  watchAccount,
-  watchBlockNumber,
-  watchContractEvent,
-  watchMulticall,
-  watchNetwork,
-  watchPendingTransactions,
-  watchPublicClient,
-  watchReadContract,
-  watchReadContracts,
-  watchWalletClient,
-  watchWebSocketPublicClient,
-  writeContract
-} from "@wagmi/core";
-export {
-  connect,
-  disconnect,
-  fetchBalance,
-  fetchBlockNumber,
-  fetchEnsAddress,
-  fetchEnsAvatar,
-  fetchEnsName,
-  fetchEnsResolver,
-  fetchFeeData,
-  fetchToken,
-  fetchTransaction,
-  getAccount,
-  getContract,
-  getNetwork,
-  getPublicClient,
-  getWalletClient,
-  getWebSocketPublicClient,
-  multicall,
-  prepareSendTransaction,
-  prepareWriteContract,
-  readContract,
-  readContracts,
-  sendTransaction,
-  signMessage,
-  signTypedData,
-  switchNetwork,
-  waitForTransaction,
-  watchAccount,
-  watchBlockNumber,
-  watchContractEvent,
-  watchMulticall,
-  watchNetwork,
-  watchPendingTransactions,
-  watchPublicClient,
-  watchReadContract,
-  watchReadContracts,
-  watchWalletClient,
-  watchWebSocketPublicClient,
-  writeContract
-};

package/dist/chains.d.ts

@@ -1,2 +0,0 @@
-export * from 'viem/chains';
-export { Chain } from 'viem/chains';

package/dist/chains.js

@@ -1,4 +0,0 @@
-"use client";
-
-// src/chains.ts
-export * from "viem/chains";

package/dist/connectors/coinbaseWallet.d.ts

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

package/dist/connectors/coinbaseWallet.js

@@ -1,7 +0,0 @@
-"use client";
-
-// src/connectors/coinbaseWallet.ts
-import { CoinbaseWalletConnector } from "@wagmi/core/connectors/coinbaseWallet";
-export {
-  CoinbaseWalletConnector
-};

package/dist/connectors/index.d.ts

@@ -1 +0,0 @@
-export { Connector, ConnectorData, ConnectorEvents } from '@wagmi/core/connectors';