wagmi 2.0.0 → 2.0.1

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "wagmi",
   "description": "React Hooks for Ethereum",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/wagmi-dev/wagmi.git",
+    "url": "https://github.com/wevm/wagmi.git",
     "directory": "packages/react"
   },
   "files": [
@@ -13,7 +13,12 @@
     "!dist/**/*.tsbuildinfo",
     "src/**/*.ts",
     "!src/**/*.test.ts",
-    "!src/**/*.test-d.ts"
+    "!src/**/*.test-d.ts",
+    "/actions",
+    "/chains",
+    "/codegen",
+    "/connectors",
+    "/query"
   ],
   "sideEffects": false,
   "type": "module",
@@ -33,6 +38,10 @@
       "types": "./dist/types/exports/chains.d.ts",
       "default": "./dist/esm/exports/chains.js"
     },
+    "./codegen": {
+      "types": "./dist/types/exports/codegen.d.ts",
+      "default": "./dist/esm/exports/codegen.js"
+    },
     "./connectors": {
       "types": "./dist/types/exports/connectors.d.ts",
       "default": "./dist/esm/exports/connectors.js"
@@ -51,6 +60,9 @@
       "chains": [
         "./dist/types/exports/chains.d.ts"
       ],
+      "codegen": [
+        "./dist/types/exports/codegen.d.ts"
+      ],
       "connectors": [
         "./dist/types/exports/connectors.d.ts"
       ],
@@ -60,10 +72,10 @@
     }
   },
   "peerDependencies": {
-    "@tanstack/react-query": "5.0.0-beta.23",
+    "@tanstack/react-query": ">=5.0.0",
     "react": ">=18",
-    "typescript": ">=5",
-    "viem": "*"
+    "typescript": ">=5.0.4",
+    "viem": "2.x"
   },
   "peerDependenciesMeta": {
     "typescript": {
@@ -71,30 +83,17 @@
     }
   },
   "dependencies": {
-    "use-sync-external-store": "^1.2.0",
-    "@wagmi/connectors": "4.0.0",
-    "@wagmi/core": "2.0.0"
-  },
-  "devDependencies": {
-    "@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.2.0",
-    "react-dom": "^18.2.0"
+    "use-sync-external-store": "1.2.0",
+    "@wagmi/connectors": "4.0.1",
+    "@wagmi/core": "2.0.1"
   },
   "contributors": [
-    "jxom.eth <j@wagmi.sh>",
-    "awkweb.eth <t@wagmi.sh>"
-  ],
-  "funding": [
-    {
-      "type": "github",
-      "url": "https://github.com/sponsors/wagmi-dev"
-    }
+    "awkweb.eth <t@wevm.dev>",
+    "jxom.eth <j@wevm.dev>"
   ],
+  "funding": "https://github.com/sponsors/wevm",
   "keywords": [
+    "wagmi",
     "react",
     "hooks",
     "eth",
@@ -102,12 +101,5 @@
     "dapps",
     "wallet",
     "web3"
-  ],
-  "scripts": {
-    "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/query/package.json

@@ -0,0 +1,5 @@
+{
+  "type": "module",
+  "types": "../dist/types/exports/query.d.ts",
+  "main": "../dist/esm/exports/query.js"
+}

package/src/context.ts

@@ -1,27 +1,28 @@
 'use client'
 
-import { type ResolvedRegister, reconnect } from '@wagmi/core'
-import { type OneOf } from '@wagmi/core/internal'
-import { createContext, createElement, useEffect } from 'react'
+import { type ResolvedRegister, type State } from '@wagmi/core'
+import { createContext, createElement } from 'react'
+import { Hydrate } from './hydrate.js'
 
 export const WagmiContext = createContext<
   ResolvedRegister['config'] | undefined
 >(undefined)
 
-export type WagmiProviderProps = OneOf<
-  { config: ResolvedRegister['config'] } | { value: ResolvedRegister['config'] }
->
+export type WagmiProviderProps = {
+  config: ResolvedRegister['config']
+  initialState?: State | undefined
+  reconnectOnMount?: boolean | undefined
+}
 
 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 { children, config } = parameters
 
-  const props = { value }
-  return createElement(WagmiContext.Provider, props, children)
+  const props = { value: config }
+  return createElement(
+    Hydrate,
+    parameters,
+    createElement(WagmiContext.Provider, props, children),
+  )
 }

package/src/errors/base.ts

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

package/src/errors/context.ts

@@ -1,8 +1,13 @@
 import { BaseError } from './base.js'
 
+export type WagmiProviderNotFoundErrorType = WagmiProviderNotFoundError & {
+  name: 'WagmiProviderNotFoundError'
+}
 export class WagmiProviderNotFoundError extends BaseError {
   override name = 'WagmiProviderNotFoundError'
   constructor() {
-    super('`useConfig` must be used within `WagmiProvider`.')
+    super('`useConfig` must be used within `WagmiProvider`.', {
+      docsPath: 'https://wagmi.sh/react/api/WagmiProvider',
+    })
   }
 }

package/src/exports/actions.ts

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

package/src/exports/chains.ts

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

package/src/exports/codegen.ts

@@ -0,0 +1,17 @@
+////////////////////////////////////////////////////////////////////////////////
+// @wagmi/core/codegen
+////////////////////////////////////////////////////////////////////////////////
+
+export * from '@wagmi/core/codegen'
+
+////////////////////////////////////////////////////////////////////////////////
+// Hooks
+////////////////////////////////////////////////////////////////////////////////
+
+export { createUseSimulateContract } from '../hooks/codegen/createUseSimulateContract.js'
+
+export { createUseReadContract } from '../hooks/codegen/createUseReadContract.js'
+
+export { createUseWatchContractEvent } from '../hooks/codegen/createUseWatchContractEvent.js'
+
+export { createUseWriteContract } from '../hooks/codegen/createUseWriteContract.js'

package/src/exports/connectors.ts

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

package/src/exports/index.ts

@@ -1,16 +1,6 @@
-////////////////////////////////////////////////////////////////////////////////
-// Viem
-
-// extremely commonly used viem exports
-export {
-  custom,
-  fallback,
-  http,
-  webSocket,
-} from 'viem'
-
 ////////////////////////////////////////////////////////////////////////////////
 // Context
+////////////////////////////////////////////////////////////////////////////////
 
 export {
   type WagmiProviderProps,
@@ -24,13 +14,18 @@ export {
 
 ////////////////////////////////////////////////////////////////////////////////
 // Errors
+////////////////////////////////////////////////////////////////////////////////
 
-export { BaseError } from '../errors/base.js'
+export { type BaseErrorType, BaseError } from '../errors/base.js'
 
-export { WagmiProviderNotFoundError } from '../errors/context.js'
+export {
+  type WagmiProviderNotFoundErrorType,
+  WagmiProviderNotFoundError,
+} from '../errors/context.js'
 
 ////////////////////////////////////////////////////////////////////////////////
 // Hooks
+////////////////////////////////////////////////////////////////////////////////
 
 export {
   type UseAccountParameters,
@@ -49,12 +44,24 @@ export {
   useBalance,
 } from '../hooks/useBalance.js'
 
+export {
+  type UseBlockParameters,
+  type UseBlockReturnType,
+  useBlock,
+} from '../hooks/useBlock.js'
+
 export {
   type UseBlockNumberParameters,
   type UseBlockNumberReturnType,
   useBlockNumber,
 } from '../hooks/useBlockNumber.js'
 
+export {
+  type UseBlockTransactionCountParameters,
+  type UseBlockTransactionCountReturnType,
+  useBlockTransactionCount,
+} from '../hooks/useBlockTransactionCount.js'
+
 export {
   type UseChainIdParameters,
   type UseChainIdReturnType,
@@ -85,30 +92,18 @@ export {
   useConnections,
 } from '../hooks/useConnections.js'
 
+export {
+  type UseConnectorsParameters,
+  type UseConnectorsReturnType,
+  useConnectors,
+} from '../hooks/useConnectors.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,
@@ -143,6 +138,8 @@ export {
   type UseEstimateFeesPerGasParameters,
   type UseEstimateFeesPerGasReturnType,
   useEstimateFeesPerGas,
+  /** @deprecated Use `useEstimateFeesPerGas` instead */
+  useEstimateFeesPerGas as useFeeData,
 } from '../hooks/useEstimateFeesPerGas.js'
 
 export {
@@ -152,10 +149,30 @@ export {
 } from '../hooks/useEstimateGas.js'
 
 export {
-  type UseContractSimulateParameters,
-  type UseContractSimulateReturnType,
-  useContractSimulate,
-} from '../hooks/useContractSimulate.js'
+  type UseEstimateMaxPriorityFeePerGasParameters,
+  type UseEstimateMaxPriorityFeePerGasReturnType,
+  useEstimateMaxPriorityFeePerGas,
+} from '../hooks/useEstimateMaxPriorityFeePerGas.js'
+
+export {
+  type UseFeeHistoryParameters,
+  type UseFeeHistoryReturnType,
+  useFeeHistory,
+} from '../hooks/useFeeHistory.js'
+
+export {
+  type UseGasPriceParameters,
+  type UseGasPriceReturnType,
+  useGasPrice,
+} from '../hooks/useGasPrice.js'
+
+export {
+  type UseInfiniteContractReadsParameters,
+  type UseInfiniteContractReadsReturnType,
+  useInfiniteReadContracts,
+  /** @deprecated Use `useInfiniteReadContracts` instead */
+  useInfiniteReadContracts as useContractInfiniteReads,
+} from '../hooks/useInfiniteReadContracts.js'
 
 export {
   type UsePublicClientParameters,
@@ -163,6 +180,22 @@ export {
   usePublicClient,
 } from '../hooks/usePublicClient.js'
 
+export {
+  type UseReadContractParameters,
+  type UseReadContractReturnType,
+  useReadContract,
+  /** @deprecated Use `useWriteContract` instead */
+  useReadContract as useContractRead,
+} from '../hooks/useReadContract.js'
+
+export {
+  type UseReadContractsParameters,
+  type UseReadContractsReturnType,
+  useReadContracts,
+  /** @deprecated Use `useWriteContract` instead */
+  useReadContracts as useContractReads,
+} from '../hooks/useReadContracts.js'
+
 export {
   type UseReconnectParameters,
   type UseReconnectReturnType,
@@ -187,6 +220,12 @@ export {
   useSignTypedData,
 } from '../hooks/useSignTypedData.js'
 
+export {
+  type UseSimulateContractParameters,
+  type UseSimulateContractReturnType,
+  useSimulateContract,
+} from '../hooks/useSimulateContract.js'
+
 export {
   type UseSwitchAccountParameters,
   type UseSwitchAccountReturnType,
@@ -202,6 +241,7 @@ export {
 export {
   type UseTokenParameters,
   type UseTokenReturnType,
+  /** @deprecated Use `useReadContracts` instead */
   useToken,
 } from '../hooks/useToken.js'
 
@@ -211,6 +251,24 @@ export {
   useTransaction,
 } from '../hooks/useTransaction.js'
 
+export {
+  type UseTransactionCountParameters,
+  type UseTransactionCountReturnType,
+  useTransactionCount,
+} from '../hooks/useTransactionCount.js'
+
+export {
+  type UseVerifyMessageParameters,
+  type UseVerifyMessageReturnType,
+  useVerifyMessage,
+} from '../hooks/useVerifyMessage.js'
+
+export {
+  type UseVerifyTypedDataParameters,
+  type UseVerifyTypedDataReturnType,
+  useVerifyTypedData,
+} from '../hooks/useVerifyTypedData.js'
+
 export {
   type UseWalletClientParameters,
   type UseWalletClientReturnType,
@@ -223,6 +281,12 @@ export {
   useWaitForTransactionReceipt,
 } from '../hooks/useWaitForTransactionReceipt.js'
 
+export {
+  type UseWatchBlocksParameters,
+  type UseWatchBlocksReturnType,
+  useWatchBlocks,
+} from '../hooks/useWatchBlocks.js'
+
 export {
   type UseWatchBlockNumberParameters,
   type UseWatchBlockNumberReturnType,
@@ -241,8 +305,26 @@ export {
   useWatchPendingTransactions,
 } from '../hooks/useWatchPendingTransactions.js'
 
+export {
+  type UseWriteContractParameters,
+  type UseWriteContractReturnType,
+  useWriteContract,
+  /** @deprecated Use `useWriteContract` instead */
+  useWriteContract as useContractWrite,
+} from '../hooks/useWriteContract.js'
+
+////////////////////////////////////////////////////////////////////////////////
+// Hydrate
+////////////////////////////////////////////////////////////////////////////////
+
+export {
+  type HydrateProps,
+  Hydrate,
+} from '../hydrate.js'
+
 ////////////////////////////////////////////////////////////////////////////////
 // @wagmi/core
+////////////////////////////////////////////////////////////////////////////////
 
 export {
   // Config
@@ -257,28 +339,44 @@ export {
   type CreateConnectorFn,
   createConnector,
   // Errors
-  ChainMismatchError,
+  type ChainNotConfiguredErrorType,
   ChainNotConfiguredError,
+  type ConnectorAlreadyConnectedErrorType,
   ConnectorAlreadyConnectedError,
+  type ConnectorNotFoundErrorType,
   ConnectorNotFoundError,
-  ConnectorAccountNotFound,
+  type ConnectorAccountNotFoundErrorType,
+  ConnectorAccountNotFoundError,
+  type ProviderNotFoundErrorType,
   ProviderNotFoundError,
+  type SwitchChainNotSupportedErrorType,
   SwitchChainNotSupportedError,
   // Storage
   type CreateStorageParameters,
   type Storage,
   createStorage,
   noopStorage,
+  // Transports
+  custom,
+  fallback,
+  http,
+  webSocket,
+  unstable_connector,
   // Types
   type Register,
   type ResolvedRegister,
   // Utilities
+  cookieStorage,
+  cookieToInitialState,
+  deepEqual,
   deserialize,
   normalizeChainId,
+  parseCookie,
   serialize,
 } from '@wagmi/core'
 
 ////////////////////////////////////////////////////////////////////////////////
 // Version
+////////////////////////////////////////////////////////////////////////////////
 
 export { version } from '../version.js'

package/src/exports/query.ts

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

package/src/hooks/codegen/createUseReadContract.ts

@@ -0,0 +1,128 @@
+import {
+  type Config,
+  type ReadContractErrorType,
+  type ReadContractParameters,
+  type ResolvedRegister,
+} from '@wagmi/core'
+import {
+  type ScopeKeyParameter,
+  type UnionEvaluate,
+  type UnionOmit,
+  type UnionPartial,
+} from '@wagmi/core/internal'
+import {
+  type ReadContractData,
+  type ReadContractQueryFnData,
+  type ReadContractQueryKey,
+} from '@wagmi/core/query'
+import {
+  type Abi,
+  type Address,
+  type ContractFunctionArgs,
+  type ContractFunctionName,
+} from 'viem'
+
+import {
+  type ConfigParameter,
+  type QueryParameter,
+} from '../../types/properties.js'
+import { useAccount } from '../useAccount.js'
+import { useChainId } from '../useChainId.js'
+import {
+  type UseReadContractReturnType,
+  useReadContract,
+} from '../useReadContract.js'
+
+type stateMutability = 'pure' | 'view'
+
+export type CreateUseReadContractParameters<
+  abi extends Abi | readonly unknown[],
+  address extends Address | Record<number, Address> | undefined = undefined,
+  functionName extends
+    | ContractFunctionName<abi, stateMutability>
+    | undefined = undefined,
+> = {
+  abi: abi | Abi | readonly unknown[]
+  address?: address | Address | Record<number, Address> | undefined
+  functionName?:
+    | functionName
+    | ContractFunctionName<abi, stateMutability>
+    | undefined
+}
+
+export type CreateUseReadContractReturnType<
+  abi extends Abi | readonly unknown[],
+  address extends Address | Record<number, Address> | undefined,
+  functionName extends ContractFunctionName<abi, stateMutability> | undefined,
+  ///
+  omittedProperties extends 'abi' | 'address' | 'chainId' | 'functionName' =
+    | 'abi'
+    | (address extends undefined ? never : 'address')
+    | (address extends Record<number, Address> ? 'chainId' : never)
+    | (functionName extends undefined ? never : 'functionName'),
+> = <
+  name extends functionName extends ContractFunctionName<abi, stateMutability>
+    ? functionName
+    : ContractFunctionName<abi, stateMutability>,
+  args extends ContractFunctionArgs<abi, stateMutability, name>,
+  config extends Config = ResolvedRegister['config'],
+  selectData = ReadContractData<abi, name, args>,
+>(
+  parameters?: UnionEvaluate<
+    UnionPartial<
+      UnionOmit<
+        ReadContractParameters<abi, name, args, config>,
+        omittedProperties
+      >
+    > &
+      ScopeKeyParameter &
+      ConfigParameter<config> &
+      QueryParameter<
+        ReadContractQueryFnData<abi, name, args>,
+        ReadContractErrorType,
+        selectData,
+        ReadContractQueryKey<abi, name, args, config>
+      >
+  > &
+    (address extends Record<number, Address>
+      ? { chainId?: keyof address | undefined }
+      : unknown),
+) => UseReadContractReturnType<abi, name, args, selectData>
+
+export function createUseReadContract<
+  const abi extends Abi | readonly unknown[],
+  const address extends
+    | Address
+    | Record<number, Address>
+    | undefined = undefined,
+  functionName extends
+    | ContractFunctionName<abi, stateMutability>
+    | undefined = undefined,
+>(
+  config: CreateUseReadContractParameters<abi, address, functionName>,
+): CreateUseReadContractReturnType<abi, address, functionName> {
+  if (config.address !== undefined && typeof config.address === 'object')
+    return (parameters) => {
+      const configChainId = useChainId()
+      const account = useAccount()
+      const chainId =
+        (parameters as { chainId?: number })?.chainId ??
+        account.chainId ??
+        configChainId
+      return useReadContract({
+        ...(parameters as any),
+        ...(config.functionName ? { functionName: config.functionName } : {}),
+        address: config.address?.[chainId],
+        abi: config.abi,
+      })
+    }
+
+  return (parameters) => {
+    return useReadContract({
+      ...(parameters as any),
+      ...(config.address ? { address: config.address } : {}),
+      ...(config.functionName ? { functionName: config.functionName } : {}),
+      abi: config.abi,
+    })
+  }
+}