wagmi 1.4.1 → 2.0.0

package/package.json

@@ -1,116 +1,69 @@
 {
   "name": "wagmi",
   "description": "React Hooks for Ethereum",
+  "version": "2.0.0",
   "license": "MIT",
-  "version": "1.4.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/wagmi-dev/wagmi.git",
     "directory": "packages/react"
   },
-  "contributors": [
-    "awkweb.eth <t@wagmi.sh>",
-    "jxom.eth <j@wagmi.sh>"
-  ],
-  "homepage": "https://wagmi.sh",
-  "ethereum": "wagmi-dev.eth",
-  "funding": [
-    {
-      "type": "gitcoin",
-      "url": "https://wagmi.sh/gitcoin"
-    },
-    {
-      "type": "github",
-      "url": "https://github.com/sponsors/wagmi-dev"
-    }
+  "files": [
+    "dist/**",
+    "!dist/**/*.tsbuildinfo",
+    "src/**/*.ts",
+    "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts"
   ],
+  "sideEffects": false,
   "type": "module",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/esm/exports/index.js",
+  "types": "./dist/types/exports/index.d.ts",
+  "typings": "./dist/types/exports/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
+      "types": "./dist/types/exports/index.d.ts",
+      "default": "./dist/esm/exports/index.js"
     },
     "./actions": {
-      "types": "./dist/actions.d.ts",
-      "default": "./dist/actions.js"
+      "types": "./dist/types/exports/actions.d.ts",
+      "default": "./dist/esm/exports/actions.js"
     },
     "./chains": {
-      "types": "./dist/chains.d.ts",
-      "default": "./dist/chains.js"
+      "types": "./dist/types/exports/chains.d.ts",
+      "default": "./dist/esm/exports/chains.js"
     },
     "./connectors": {
-      "types": "./dist/connectors/index.d.ts",
-      "default": "./dist/connectors/index.js"
-    },
-    "./connectors/coinbaseWallet": {
-      "types": "./dist/connectors/coinbaseWallet.d.ts",
-      "default": "./dist/connectors/coinbaseWallet.js"
-    },
-    "./connectors/injected": {
-      "types": "./dist/connectors/injected.d.ts",
-      "default": "./dist/connectors/injected.js"
-    },
-    "./connectors/ledger": {
-      "types": "./dist/connectors/ledger.d.ts",
-      "default": "./dist/connectors/ledger.js"
-    },
-    "./connectors/metaMask": {
-      "types": "./dist/connectors/metaMask.d.ts",
-      "default": "./dist/connectors/metaMask.js"
-    },
-    "./connectors/mock": {
-      "types": "./dist/connectors/mock.d.ts",
-      "default": "./dist/connectors/mock.js"
-    },
-    "./connectors/safe": {
-      "types": "./dist/connectors/safe.d.ts",
-      "default": "./dist/connectors/safe.js"
-    },
-    "./connectors/walletConnect": {
-      "types": "./dist/connectors/walletConnect.d.ts",
-      "default": "./dist/connectors/walletConnect.js"
+      "types": "./dist/types/exports/connectors.d.ts",
+      "default": "./dist/esm/exports/connectors.js"
     },
-    "./connectors/walletConnectLegacy": {
-      "types": "./dist/connectors/walletConnectLegacy.d.ts",
-      "default": "./dist/connectors/walletConnectLegacy.js"
-    },
-    "./providers/alchemy": {
-      "types": "./dist/providers/alchemy.d.ts",
-      "default": "./dist/providers/alchemy.js"
-    },
-    "./providers/infura": {
-      "types": "./dist/providers/infura.d.ts",
-      "default": "./dist/providers/infura.js"
-    },
-    "./providers/jsonRpc": {
-      "types": "./dist/providers/jsonRpc.d.ts",
-      "default": "./dist/providers/jsonRpc.js"
-    },
-    "./providers/public": {
-      "types": "./dist/providers/public.d.ts",
-      "default": "./dist/providers/public.js"
-    },
-    "./window": {
-      "types": "./dist/window.d.ts",
-      "default": "./dist/window.js"
+    "./query": {
+      "types": "./dist/types/exports/query.d.ts",
+      "default": "./dist/esm/exports/query.js"
     },
     "./package.json": "./package.json"
   },
-  "sideEffects": false,
-  "files": [
-    "/actions",
-    "/chains",
-    "/connectors",
-    "/providers",
-    "/window",
-    "/dist"
-  ],
+  "typesVersions": {
+    "*": {
+      "actions": [
+        "./dist/types/exports/actions.d.ts"
+      ],
+      "chains": [
+        "./dist/types/exports/chains.d.ts"
+      ],
+      "connectors": [
+        "./dist/types/exports/connectors.d.ts"
+      ],
+      "query": [
+        "./dist/types/exports/query.d.ts"
+      ]
+    }
+  },
   "peerDependencies": {
-    "react": ">=17.0.0",
-    "typescript": ">=5.0.4",
-    "viem": ">=0.3.35"
+    "@tanstack/react-query": "5.0.0-beta.23",
+    "react": ">=18",
+    "typescript": ">=5",
+    "viem": "*"
   },
   "peerDependenciesMeta": {
     "typescript": {
@@ -118,23 +71,29 @@
     }
   },
   "dependencies": {
-    "@tanstack/query-sync-storage-persister": "^4.27.1",
-    "@tanstack/react-query": "^4.28.0",
-    "@tanstack/react-query-persist-client": "^4.28.0",
-    "abitype": "0.8.7",
     "use-sync-external-store": "^1.2.0",
-    "@wagmi/core": "1.4.1"
+    "@wagmi/connectors": "4.0.0",
+    "@wagmi/core": "2.0.0"
   },
   "devDependencies": {
-    "@testing-library/react": "^13.3.0",
-    "@testing-library/react-hooks": "^8.0.1",
-    "@types/react": "^18.0.9",
-    "@types/react-dom": "^18.0.3",
+    "@tanstack/react-query": "5.0.0-beta.23",
+    "@testing-library/react": "^14.0.0",
+    "@types/react": "^18.2.21",
+    "@types/react-dom": "^18.2.7",
     "@types/use-sync-external-store": "^0.0.3",
-    "react": "^18.1.0",
-    "react-dom": "^18.1.0",
-    "viem": "^1.0.0"
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
   },
+  "contributors": [
+    "jxom.eth <j@wagmi.sh>",
+    "awkweb.eth <t@wagmi.sh>"
+  ],
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/wagmi-dev"
+    }
+  ],
   "keywords": [
     "react",
     "hooks",
@@ -145,7 +104,10 @@
     "web3"
   ],
   "scripts": {
-    "build": "tsup",
-    "dev": "DEV=true tsup"
+    "clean": "rm -rf dist tsconfig.tsbuildinfo",
+    "build": "pnpm run clean && pnpm run build:esm+types",
+    "build:esm+types": "tsc --project tsconfig.build.json --module es2020 --outDir ./dist/esm --declaration --declarationMap --declarationDir ./dist/types",
+    "test:build": "publint --strict",
+    "typecheck": "tsc --noEmit"
   }
 }

package/src/context.ts

@@ -0,0 +1,27 @@
+'use client'
+
+import { type ResolvedRegister, reconnect } from '@wagmi/core'
+import { type OneOf } from '@wagmi/core/internal'
+import { createContext, createElement, useEffect } from 'react'
+
+export const WagmiContext = createContext<
+  ResolvedRegister['config'] | undefined
+>(undefined)
+
+export type WagmiProviderProps = OneOf<
+  { config: ResolvedRegister['config'] } | { value: ResolvedRegister['config'] }
+>
+
+export function WagmiProvider(
+  parameters: React.PropsWithChildren<WagmiProviderProps>,
+) {
+  const { children, value = parameters.config! } = parameters
+  // biome-ignore lint/nursery/useExhaustiveDependencies: only run on mount
+  useEffect(() => {
+    if (typeof window !== 'undefined' && value._internal.reconnectOnMount)
+      reconnect(value)
+  }, [])
+
+  const props = { value }
+  return createElement(WagmiContext.Provider, props, children)
+}

package/src/errors/base.ts

@@ -0,0 +1,13 @@
+import { BaseError as CoreError } from '@wagmi/core'
+
+import { getVersion } from '../utils/getVersion.js'
+
+export class BaseError extends CoreError {
+  override name = 'WagmiError'
+  override get docsBaseUrl() {
+    return 'https://alpha.wagmi.sh/react'
+  }
+  override get version() {
+    return getVersion()
+  }
+}

package/src/errors/context.ts

@@ -0,0 +1,8 @@
+import { BaseError } from './base.js'
+
+export class WagmiProviderNotFoundError extends BaseError {
+  override name = 'WagmiProviderNotFoundError'
+  constructor() {
+    super('`useConfig` must be used within `WagmiProvider`.')
+  }
+}

package/src/exports/actions.ts

@@ -0,0 +1,4 @@
+////////////////////////////////////////////////////////////////////////////////
+// @wagmi/core/api/actions
+
+export * from '@wagmi/core/actions'

package/src/exports/chains.ts

@@ -0,0 +1,4 @@
+////////////////////////////////////////////////////////////////////////////////
+// viem/chains
+
+export * from 'viem/chains'

package/src/exports/connectors.ts

@@ -0,0 +1,4 @@
+////////////////////////////////////////////////////////////////////////////////
+// @wagmi/connectors
+
+export * from '@wagmi/connectors'

package/src/exports/index.ts

@@ -0,0 +1,284 @@
+////////////////////////////////////////////////////////////////////////////////
+// Viem
+
+// extremely commonly used viem exports
+export {
+  custom,
+  fallback,
+  http,
+  webSocket,
+} from 'viem'
+
+////////////////////////////////////////////////////////////////////////////////
+// Context
+
+export {
+  type WagmiProviderProps,
+  WagmiContext,
+  WagmiProvider,
+  /** @deprecated Use `WagmiContext` instead */
+  WagmiContext as Context,
+  /** @deprecated Use `WagmiProvider` instead */
+  WagmiProvider as WagmiConfig,
+} from '../context.js'
+
+////////////////////////////////////////////////////////////////////////////////
+// Errors
+
+export { BaseError } from '../errors/base.js'
+
+export { WagmiProviderNotFoundError } from '../errors/context.js'
+
+////////////////////////////////////////////////////////////////////////////////
+// Hooks
+
+export {
+  type UseAccountParameters,
+  type UseAccountReturnType,
+  useAccount,
+} from '../hooks/useAccount.js'
+
+export {
+  type UseAccountEffectParameters,
+  useAccountEffect,
+} from '../hooks/useAccountEffect.js'
+
+export {
+  type UseBalanceParameters,
+  type UseBalanceReturnType,
+  useBalance,
+} from '../hooks/useBalance.js'
+
+export {
+  type UseBlockNumberParameters,
+  type UseBlockNumberReturnType,
+  useBlockNumber,
+} from '../hooks/useBlockNumber.js'
+
+export {
+  type UseChainIdParameters,
+  type UseChainIdReturnType,
+  useChainId,
+} from '../hooks/useChainId.js'
+
+export {
+  type UseClientParameters,
+  type UseClientReturnType,
+  useClient,
+} from '../hooks/useClient.js'
+
+export {
+  type UseConfigParameters,
+  type UseConfigReturnType,
+  useConfig,
+} from '../hooks/useConfig.js'
+
+export {
+  type UseConnectParameters,
+  type UseConnectReturnType,
+  useConnect,
+} from '../hooks/useConnect.js'
+
+export {
+  type UseConnectionsParameters,
+  type UseConnectionsReturnType,
+  useConnections,
+} from '../hooks/useConnections.js'
+
+export {
+  type UseConnectorClientParameters,
+  type UseConnectorClientReturnType,
+  useConnectorClient,
+} from '../hooks/useConnectorClient.js'
+
+export {
+  type UseContractReadParameters,
+  type UseContractReadReturnType,
+  useContractRead,
+} from '../hooks/useContractRead.js'
+
+export {
+  type UseContractReadsParameters,
+  type UseContractReadsReturnType,
+  useContractReads,
+} from '../hooks/useContractReads.js'
+
+export {
+  type UseContractWriteParameters,
+  type UseContractWriteReturnType,
+  useContractWrite,
+} from '../hooks/useContractWrite.js'
+
+export {
+  type UseDisconnectParameters,
+  type UseDisconnectReturnType,
+  useDisconnect,
+} from '../hooks/useDisconnect.js'
+
+export {
+  type UseEnsAddressParameters,
+  type UseEnsAddressReturnType,
+  useEnsAddress,
+} from '../hooks/useEnsAddress.js'
+
+export {
+  type UseEnsAvatarParameters,
+  type UseEnsAvatarReturnType,
+  useEnsAvatar,
+} from '../hooks/useEnsAvatar.js'
+
+export {
+  type UseEnsNameParameters,
+  type UseEnsNameReturnType,
+  useEnsName,
+} from '../hooks/useEnsName.js'
+
+export {
+  type UseEnsResolverParameters,
+  type UseEnsResolverReturnType,
+  useEnsResolver,
+} from '../hooks/useEnsResolver.js'
+
+export {
+  type UseEstimateFeesPerGasParameters,
+  type UseEstimateFeesPerGasReturnType,
+  useEstimateFeesPerGas,
+} from '../hooks/useEstimateFeesPerGas.js'
+
+export {
+  type UseEstimateGasParameters,
+  type UseEstimateGasReturnType,
+  useEstimateGas,
+} from '../hooks/useEstimateGas.js'
+
+export {
+  type UseContractSimulateParameters,
+  type UseContractSimulateReturnType,
+  useContractSimulate,
+} from '../hooks/useContractSimulate.js'
+
+export {
+  type UsePublicClientParameters,
+  type UsePublicClientReturnType,
+  usePublicClient,
+} from '../hooks/usePublicClient.js'
+
+export {
+  type UseReconnectParameters,
+  type UseReconnectReturnType,
+  useReconnect,
+} from '../hooks/useReconnect.js'
+
+export {
+  type UseSendTransactionParameters,
+  type UseSendTransactionReturnType,
+  useSendTransaction,
+} from '../hooks/useSendTransaction.js'
+
+export {
+  type UseSignMessageParameters,
+  type UseSignMessageReturnType,
+  useSignMessage,
+} from '../hooks/useSignMessage.js'
+
+export {
+  type UseSignTypedDataParameters,
+  type UseSignTypedDataReturnType,
+  useSignTypedData,
+} from '../hooks/useSignTypedData.js'
+
+export {
+  type UseSwitchAccountParameters,
+  type UseSwitchAccountReturnType,
+  useSwitchAccount,
+} from '../hooks/useSwitchAccount.js'
+
+export {
+  type UseSwitchChainParameters,
+  type UseSwitchChainReturnType,
+  useSwitchChain,
+} from '../hooks/useSwitchChain.js'
+
+export {
+  type UseTokenParameters,
+  type UseTokenReturnType,
+  useToken,
+} from '../hooks/useToken.js'
+
+export {
+  type UseTransactionParameters,
+  type UseTransactionReturnType,
+  useTransaction,
+} from '../hooks/useTransaction.js'
+
+export {
+  type UseWalletClientParameters,
+  type UseWalletClientReturnType,
+  useWalletClient,
+} from '../hooks/useWalletClient.js'
+
+export {
+  type UseWaitForTransactionReceiptParameters,
+  type UseWaitForTransactionReceiptReturnType,
+  useWaitForTransactionReceipt,
+} from '../hooks/useWaitForTransactionReceipt.js'
+
+export {
+  type UseWatchBlockNumberParameters,
+  type UseWatchBlockNumberReturnType,
+  useWatchBlockNumber,
+} from '../hooks/useWatchBlockNumber.js'
+
+export {
+  type UseWatchContractEventParameters,
+  type UseWatchContractEventReturnType,
+  useWatchContractEvent,
+} from '../hooks/useWatchContractEvent.js'
+
+export {
+  type UseWatchPendingTransactionsParameters,
+  type UseWatchPendingTransactionsReturnType,
+  useWatchPendingTransactions,
+} from '../hooks/useWatchPendingTransactions.js'
+
+////////////////////////////////////////////////////////////////////////////////
+// @wagmi/core
+
+export {
+  // Config
+  type Connection,
+  type Connector,
+  type Config,
+  type CreateConfigParameters,
+  type State,
+  createConfig,
+  // Connector
+  type ConnectorEventMap,
+  type CreateConnectorFn,
+  createConnector,
+  // Errors
+  ChainMismatchError,
+  ChainNotConfiguredError,
+  ConnectorAlreadyConnectedError,
+  ConnectorNotFoundError,
+  ConnectorAccountNotFound,
+  ProviderNotFoundError,
+  SwitchChainNotSupportedError,
+  // Storage
+  type CreateStorageParameters,
+  type Storage,
+  createStorage,
+  noopStorage,
+  // Types
+  type Register,
+  type ResolvedRegister,
+  // Utilities
+  deserialize,
+  normalizeChainId,
+  serialize,
+} from '@wagmi/core'
+
+////////////////////////////////////////////////////////////////////////////////
+// Version
+
+export { version } from '../version.js'

package/src/exports/query.ts

@@ -0,0 +1,4 @@
+////////////////////////////////////////////////////////////////////////////////
+// @wagmi/core/query
+
+export * from '@wagmi/core/query'

package/src/hooks/useAccount.ts

@@ -0,0 +1,27 @@
+'use client'
+
+import {
+  type GetAccountReturnType,
+  getAccount,
+  watchAccount,
+} from '@wagmi/core'
+
+import type { ConfigParameter } from '../types/properties.js'
+import { useConfig } from './useConfig.js'
+import { useSyncExternalStoreWithTracked } from './useSyncExternalStoreWithTracked.js'
+
+export type UseAccountParameters = ConfigParameter
+
+export type UseAccountReturnType = GetAccountReturnType
+
+/** https://alpha.wagmi.sh/react/api/hooks/useAccount */
+export function useAccount(
+  parameters: UseAccountParameters = {},
+): UseAccountReturnType {
+  const config = useConfig(parameters)
+
+  return useSyncExternalStoreWithTracked(
+    (onChange) => watchAccount(config, { onChange }),
+    () => getAccount(config),
+  )
+}

package/src/hooks/useAccountEffect.ts

@@ -0,0 +1,55 @@
+'use client'
+
+import { type GetAccountReturnType, watchAccount } from '@wagmi/core'
+import type { Evaluate } from '@wagmi/core/internal'
+import { useEffect } from 'react'
+
+import type { ConfigParameter } from '../types/properties.js'
+import { useConfig } from './useConfig.js'
+
+export type UseAccountEffectParameters = Evaluate<
+  {
+    onConnect?(
+      data: Evaluate<
+        Pick<
+          Extract<GetAccountReturnType, { status: 'connected' }>,
+          'address' | 'addresses' | 'chainId' | 'connector'
+        > & {
+          isReconnected: boolean
+        }
+      >,
+    ): void
+    onDisconnect?(): void
+  } & ConfigParameter
+>
+
+/** https://alpha.wagmi.sh/react/api/hooks/useAccountEffect */
+export function useAccountEffect(parameters: UseAccountEffectParameters = {}) {
+  const { onConnect, onDisconnect } = parameters
+
+  const config = useConfig(parameters)
+
+  useEffect(() => {
+    return watchAccount(config, {
+      onChange(data, prevData) {
+        if (
+          (prevData.status === 'reconnecting' ||
+            (prevData.status === 'connecting' &&
+              prevData.address === undefined)) &&
+          data.status === 'connected'
+        ) {
+          const { address, addresses, chainId, connector } = data
+          const isReconnected =
+            prevData.status === 'reconnecting' ||
+            // if `previousAccount.status` is `undefined`, the connector connected immediately.
+            prevData.status === undefined
+          onConnect?.({ address, addresses, chainId, connector, isReconnected })
+        } else if (
+          prevData.status === 'connected' &&
+          data.status === 'disconnected'
+        )
+          onDisconnect?.()
+      },
+    })
+  }, [config, onConnect, onDisconnect])
+}