@wagmi/core 2.0.0-alpha.9 → 2.0.0-beta.0

package/src/actions/watchPublicClient.ts

@@ -1,4 +1,4 @@
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import {
   type GetPublicClientReturnType,
   getPublicClient,
@@ -16,7 +16,7 @@ export type WatchPublicClientParameters<
 
 export type WatchPublicClientReturnType = () => void
 
-/** https://alpha.wagmi.sh/core/api/actions/watchPublicClient */
+/** https://beta.wagmi.sh/core/api/actions/watchPublicClient */
 export function watchPublicClient<
   config extends Config,
   chainId extends config['chains'][number]['id'],

package/src/actions/writeContract.ts

@@ -12,16 +12,20 @@ import {
   writeContract as viem_writeContract,
 } from 'viem/actions'
 
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
+import type { BaseErrorType, ErrorType } from '../errors/base.js'
 import type { SelectChains } from '../types/chain.js'
 import type {
   ChainIdParameter,
   ConnectorParameter,
 } from '../types/properties.js'
 import type { Evaluate, UnionEvaluate, UnionOmit } from '../types/utils.js'
-import { assertActiveChain } from '../utils/assertActiveChain.js'
-import { getConnectorClient } from './getConnectorClient.js'
 import {
+  type GetConnectorClientErrorType,
+  getConnectorClient,
+} from './getConnectorClient.js'
+import {
+  type SimulateContractErrorType,
   type SimulateContractParameters,
   simulateContract,
 } from './simulateContract.js'
@@ -63,9 +67,18 @@ export type WriteContractParameters<
 
 export type WriteContractReturnType = viem_WriteContractReturnType
 
-export type WriteContractErrorType = viem_WriteContractErrorType
+export type WriteContractErrorType =
+  // getConnectorClient()
+  | GetConnectorClientErrorType
+  // simulateContract()
+  | SimulateContractErrorType
+  // base
+  | BaseErrorType
+  | ErrorType
+  // viem
+  | viem_WriteContractErrorType
 
-/** https://alpha.wagmi.sh/core/api/actions/writeContract */
+/** https://beta.wagmi.sh/core/api/actions/writeContract */
 export async function writeContract<
   config extends Config,
   const abi extends Abi | readonly unknown[],
@@ -89,11 +102,8 @@ export async function writeContract<
   })
 
   let request
-  if (__mode === 'prepared') {
-    if (chainId)
-      assertActiveChain(config, { activeChainId: client.chain.id, chainId })
-    request = rest
-  } else {
+  if (__mode === 'prepared') request = rest
+  else {
     const { request: simulateRequest } = await simulateContract(
       config,
       rest as SimulateContractParameters,

package/src/connectors/injected.ts

@@ -13,7 +13,7 @@ import {
 
 import { ChainNotConfiguredError } from '../errors/config.js'
 import { ProviderNotFoundError } from '../errors/connector.js'
-import type { Evaluate } from '../types/utils.js'
+import { type Evaluate } from '../types/utils.js'
 import { normalizeChainId } from '../utils/normalizeChainId.js'
 import { createConnector } from './createConnector.js'
 

package/src/createConfig.ts

@@ -1,4 +1,8 @@
-import { type EIP6963ProviderDetail, createStore as createMipd } from 'mipd'
+import {
+  type EIP6963ProviderDetail,
+  type Store as MipdStore,
+  createStore as createMipd,
+} from 'mipd'
 import {
   type Address,
   type Chain,
@@ -8,7 +12,7 @@ import {
   createClient,
 } from 'viem'
 import { persist, subscribeWithSelector } from 'zustand/middleware'
-import { createStore } from 'zustand/vanilla'
+import { type Mutate, type StoreApi, createStore } from 'zustand/vanilla'
 
 import {
   type ConnectorEventMap,
@@ -33,6 +37,7 @@ export type CreateConfigParameters<
     connectors?: CreateConnectorFn[] | undefined
     multiInjectedProviderDiscovery?: boolean | undefined
     storage?: Storage | null | undefined
+    ssr?: boolean | undefined
     syncConnectedChain?: boolean | undefined
   } & OneOf<
     | ({ transports: transports } & {
@@ -66,6 +71,7 @@ export function createConfig<
           : noopStorage,
     }),
     syncConnectedChain = true,
+    ssr,
     ...rest
   } = parameters
 
@@ -81,7 +87,9 @@ export function createConfig<
   const connectors = createStore(() =>
     [
       ...(rest.connectors ?? []),
-      ...(mipd?.getProviders().map(providerDetailToConnector) ?? []),
+      ...(!ssr
+        ? mipd?.getProviders().map(providerDetailToConnector) ?? []
+        : []),
     ].map(setup),
   )
   function setup(connectorFn: CreateConnectorFn) {
@@ -174,10 +182,12 @@ export function createConfig<
             name: 'store',
             partialize(state) {
               return {
+                connections: state.connections,
                 chainId: state.chainId,
                 current: state.current,
               } satisfies PartializedState
             },
+            skipHydration: ssr,
             storage: storage as Storage<Record<string, unknown>>,
             version: 1,
           })
@@ -318,9 +328,13 @@ export function createConfig<
     },
 
     _internal: {
+      mipd,
+      store,
+      ssr: Boolean(ssr),
       syncConnectedChain,
       transports: rest.transports as transports,
       connectors: {
+        providerDetailToConnector,
         setup,
         setState: (value) =>
           connectors.setState(
@@ -369,10 +383,16 @@ export type Config<
   }): Client<transports[chainId], Extract<chains[number], { id: chainId }>>
 
   _internal: {
+    readonly mipd: MipdStore | undefined
+    readonly store: Mutate<StoreApi<any>, [['zustand/persist', any]]>
+    readonly ssr: boolean
     readonly syncConnectedChain: boolean
     readonly transports: transports
 
     connectors: {
+      providerDetailToConnector(
+        providerDetail: EIP6963ProviderDetail,
+      ): CreateConnectorFn
       setup(connectorFn: CreateConnectorFn): Connector
       setState(value: Connector[] | ((state: Connector[]) => Connector[])): void
       subscribe(

package/src/createStorage.ts

@@ -1,5 +1,5 @@
 import { type PartializedState } from './createConfig.js'
-import type { Evaluate } from './types/utils.js'
+import { type Evaluate } from './types/utils.js'
 import { deserialize as deserialize_ } from './utils/deserialize.js'
 import { serialize as serialize_ } from './utils/serialize.js'
 
@@ -14,6 +14,7 @@ export type Storage<
   ///
   storageItemMap extends StorageItemMap = StorageItemMap & itemMap,
 > = {
+  key: string
   getItem<
     key extends keyof storageItemMap,
     value extends storageItemMap[key],
@@ -31,7 +32,7 @@ export type Storage<
   removeItem(key: keyof storageItemMap): void | Promise<void>
 }
 
-type BaseStorage = {
+export type BaseStorage = {
   getItem(
     key: string,
   ): string | null | undefined | Promise<string | null | undefined>
@@ -64,6 +65,7 @@ export function createStorage<
 
   return {
     ...storage,
+    key: prefix,
     async getItem(key, defaultValue) {
       const value = storage.getItem(`${prefix}.${key as string}`)
       const unwrapped = await unwrap(value)

package/src/errors/base.ts

@@ -1,6 +1,8 @@
 import type { Evaluate, OneOf } from '../types/utils.js'
 import { getVersion } from '../utils/getVersion.js'
 
+export type ErrorType<name extends string = 'Error'> = Error & { name: name }
+
 type BaseErrorOptions = Evaluate<
   OneOf<{ details?: string | undefined } | { cause: BaseError | Error }> & {
     docsPath?: string | undefined
@@ -9,6 +11,7 @@ type BaseErrorOptions = Evaluate<
   }
 >
 
+export type BaseErrorType = BaseError & { name: 'WagmiCoreError' }
 export class BaseError extends Error {
   details: string
   docsPath?: string | undefined
@@ -17,7 +20,7 @@ export class BaseError extends Error {
 
   override name = 'WagmiCoreError'
   get docsBaseUrl() {
-    return 'https://alpha.wagmi.sh/core'
+    return 'https://beta.wagmi.sh/core'
   }
   get version() {
     return getVersion()

package/src/errors/config.ts

@@ -1,23 +1,11 @@
-import type { Address } from 'viem'
+import { type Address } from 'viem'
+
 import type { Connector } from '../createConfig.js'
 import { BaseError } from './base.js'
 
-export class ChainMismatchError extends BaseError {
-  override name = 'ChainMismatchError'
-
-  constructor({
-    activeChain,
-    targetChain,
-  }: {
-    activeChain: string
-    targetChain: string
-  }) {
-    super('Chain mismatch', {
-      details: `Expected "${targetChain}", received "${activeChain}".`,
-    })
-  }
+export type ChainNotConfiguredErrorType = ChainNotConfiguredError & {
+  name: 'ChainNotConfiguredError'
 }
-
 export class ChainNotConfiguredError extends BaseError {
   override name = 'ChainNotConfiguredError'
   constructor() {
@@ -25,6 +13,10 @@ export class ChainNotConfiguredError extends BaseError {
   }
 }
 
+export type ConnectorAlreadyConnectedErrorType =
+  ConnectorAlreadyConnectedError & {
+    name: 'ConnectorAlreadyConnectedError'
+  }
 export class ConnectorAlreadyConnectedError extends BaseError {
   override name = 'ConnectorAlreadyConnectedError'
   constructor() {
@@ -32,6 +24,9 @@ export class ConnectorAlreadyConnectedError extends BaseError {
   }
 }
 
+export type ConnectorNotConnectedErrorType = ConnectorNotConnectedError & {
+  name: 'ConnectorNotConnectedError'
+}
 export class ConnectorNotConnectedError extends BaseError {
   override name = 'ConnectorNotConnectedError'
   constructor() {
@@ -39,6 +34,9 @@ export class ConnectorNotConnectedError extends BaseError {
   }
 }
 
+export type ConnectorNotFoundErrorType = ConnectorNotFoundError & {
+  name: 'ConnectorNotFoundError'
+}
 export class ConnectorNotFoundError extends BaseError {
   override name = 'ConnectorNotFoundError'
   constructor() {
@@ -46,8 +44,12 @@ export class ConnectorNotFoundError extends BaseError {
   }
 }
 
-export class ConnectorAccountNotFound extends BaseError {
-  override name = 'ConnectorAccountNotFound'
+export type ConnectorAccountNotFoundErrorType =
+  ConnectorAccountNotFoundError & {
+    name: 'ConnectorAccountNotFoundError'
+  }
+export class ConnectorAccountNotFoundError extends BaseError {
+  override name = 'ConnectorAccountNotFoundError'
   constructor({
     address,
     connector,

package/src/errors/connector.ts

@@ -1,6 +1,9 @@
 import type { Connector } from '../createConfig.js'
 import { BaseError } from './base.js'
 
+export type ProviderNotFoundErrorType = ProviderNotFoundError & {
+  name: 'ProviderNotFoundError'
+}
 export class ProviderNotFoundError extends BaseError {
   override name = 'ProviderNotFoundError'
   constructor() {
@@ -8,6 +11,9 @@ export class ProviderNotFoundError extends BaseError {
   }
 }
 
+export type SwitchChainNotSupportedErrorType = SwitchChainNotSupportedError & {
+  name: 'SwitchChainNotSupportedError'
+}
 export class SwitchChainNotSupportedError extends BaseError {
   override name = 'SwitchChainNotSupportedError'
 

package/src/exports/index.ts

@@ -344,22 +344,33 @@ export {
   noopStorage,
 } from '../createStorage.js'
 
+////////////////////////////////////////////////////////////////////////////////
+// hydrate
+
+export { hydrate } from '../hydrate.js'
+
 ////////////////////////////////////////////////////////////////////////////////
 // Errors
 
 export { BaseError } from '../errors/base.js'
 
 export {
-  ChainMismatchError,
+  type ChainNotConfiguredErrorType,
   ChainNotConfiguredError,
+  type ConnectorNotConnectedErrorType,
   ConnectorNotConnectedError,
+  type ConnectorAlreadyConnectedErrorType,
   ConnectorAlreadyConnectedError,
+  type ConnectorNotFoundErrorType,
   ConnectorNotFoundError,
-  ConnectorAccountNotFound,
+  type ConnectorAccountNotFoundErrorType,
+  ConnectorAccountNotFoundError,
 } from '../errors/config.js'
 
 export {
+  type ProviderNotFoundErrorType,
   ProviderNotFoundError,
+  type SwitchChainNotSupportedErrorType,
   SwitchChainNotSupportedError,
 } from '../errors/connector.js'
 
@@ -371,6 +382,12 @@ export { type Register, type ResolvedRegister } from '../types/register.js'
 ////////////////////////////////////////////////////////////////////////////////
 // Utilities
 
+export {
+  cookieStorage,
+  cookieToInitialState,
+  parseCookie,
+} from '../utils/cookie.js'
+
 export { deepEqual } from '../utils/deepEqual.js'
 
 export { deserialize } from '../utils/deserialize.js'

package/src/hydrate.ts

@@ -0,0 +1,42 @@
+import { reconnect } from './actions/reconnect.js'
+import type { Config, State } from './createConfig.js'
+
+type HydrateParameters = {
+  initialState?: State | undefined
+  reconnectOnMount?: boolean | undefined
+}
+
+export function hydrate(config: Config, parameters: HydrateParameters) {
+  const { initialState, reconnectOnMount } = parameters
+
+  if (initialState)
+    config.setState({
+      ...initialState,
+      connections: reconnectOnMount ? initialState.connections : new Map(),
+      status: reconnectOnMount ? 'reconnecting' : 'disconnected',
+    })
+
+  return {
+    async onMount() {
+      if (config._internal.ssr) {
+        await config._internal.store.persist.rehydrate()
+        const mipdConnectors = config._internal.mipd
+          ?.getProviders()
+          .map(config._internal.connectors.providerDetailToConnector)
+          .map(config._internal.connectors.setup)
+        config._internal.connectors.setState((connectors) => [
+          ...connectors,
+          ...(mipdConnectors ?? []),
+        ])
+      }
+
+      if (reconnectOnMount) reconnect(config)
+      else if (config.storage)
+        // Reset connections that may have been hydrated from storage.
+        config.setState((x) => ({
+          ...x,
+          connections: new Map(),
+        }))
+    },
+  }
+}

package/src/query/disconnect.ts

@@ -6,7 +6,7 @@ import {
   type DisconnectReturnType,
   disconnect,
 } from '../actions/disconnect.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { Mutate, MutateAsync } from './types.js'
 
 export function disconnectMutationOptions<config extends Config>(

package/src/query/estimateFeesPerGas.ts

@@ -7,7 +7,7 @@ import {
   type EstimateFeesPerGasReturnType,
   estimateFeesPerGas,
 } from '../actions/estimateFeesPerGas.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { Evaluate, ExactPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/estimateGas.ts

@@ -6,7 +6,7 @@ import {
   type EstimateGasReturnType,
   estimateGas,
 } from '../actions/estimateGas.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { UnionPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/getBalance.ts

@@ -6,7 +6,7 @@ import {
   type GetBalanceReturnType,
   getBalance,
 } from '../actions/getBalance.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { Evaluate, PartialBy } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/getBlock.ts

@@ -7,7 +7,7 @@ import {
   type GetBlockReturnType,
   getBlock,
 } from '../actions/getBlock.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { Evaluate, ExactPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/getBlockNumber.ts

@@ -6,7 +6,7 @@ import {
   type GetBlockNumberReturnType,
   getBlockNumber,
 } from '../actions/getBlockNumber.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { Evaluate, ExactPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/getConnectorClient.ts

@@ -6,7 +6,7 @@ import {
   type GetConnectorClientReturnType,
   getConnectorClient,
 } from '../actions/getConnectorClient.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { Evaluate, ExactPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/getEnsAddress.ts

@@ -6,7 +6,7 @@ import {
   type GetEnsAddressReturnType,
   getEnsAddress,
 } from '../actions/getEnsAddress.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { Evaluate, ExactPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/getEnsAvatar.ts

@@ -6,7 +6,7 @@ import {
   type GetEnsAvatarReturnType,
   getEnsAvatar,
 } from '../actions/getEnsAvatar.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { Evaluate, ExactPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/getEnsName.ts

@@ -6,7 +6,7 @@ import {
   type GetEnsNameReturnType,
   getEnsName,
 } from '../actions/getEnsName.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { Evaluate, ExactPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/getEnsResolver.ts

@@ -6,7 +6,7 @@ import {
   type GetEnsResolverReturnType,
   getEnsResolver,
 } from '../actions/getEnsResolver.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { Evaluate, ExactPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/getToken.ts

@@ -6,7 +6,7 @@ import {
   type GetTokenReturnType,
   getToken,
 } from '../actions/getToken.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { Evaluate, ExactPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/getTransaction.ts

@@ -6,7 +6,7 @@ import {
   type GetTransactionReturnType,
   getTransaction,
 } from '../actions/getTransaction.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { Evaluate, ExactPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/getWalletClient.ts

@@ -6,7 +6,7 @@ import {
   type GetWalletClientReturnType,
   getWalletClient,
 } from '../actions/getWalletClient.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { Evaluate, ExactPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/infiniteReadContracts.ts

@@ -5,8 +5,8 @@ import {
   type ReadContractsReturnType,
   readContracts,
 } from '../actions/readContracts.js'
-import type { Config } from '../createConfig.js'
-import type { ChainIdParameter } from '../types/properties.js'
+import { type Config } from '../createConfig.js'
+import { type ChainIdParameter } from '../types/properties.js'
 import type { Omit } from '../types/utils.js'
 import type { InfiniteQueryOptions, ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/readContract.ts

@@ -11,7 +11,7 @@ import {
   type ReadContractReturnType,
   readContract,
 } from '../actions/readContract.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { UnionPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/readContracts.ts

@@ -9,8 +9,8 @@ import {
   type ReadContractsReturnType,
   readContracts,
 } from '../actions/readContracts.js'
-import type { Config } from '../createConfig.js'
-import type { ChainIdParameter } from '../types/properties.js'
+import { type Config } from '../createConfig.js'
+import { type ChainIdParameter } from '../types/properties.js'
 import type { ExactPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/reconnect.ts

@@ -6,8 +6,8 @@ import {
   type ReconnectReturnType,
   reconnect,
 } from '../actions/reconnect.js'
-import type { Config } from '../createConfig.js'
-import type { Evaluate } from '../types/utils.js'
+import { type Config } from '../createConfig.js'
+import { type Evaluate } from '../types/utils.js'
 import type { Mutate, MutateAsync } from './types.js'
 
 export function reconnectMutationOptions(config: Config) {

package/src/query/sendTransaction.ts

@@ -7,7 +7,7 @@ import {
   sendTransaction,
 } from '../actions/sendTransaction.js'
 import { type Config } from '../createConfig.js'
-import type { Evaluate } from '../types/utils.js'
+import { type Evaluate } from '../types/utils.js'
 
 export function sendTransactionMutationOptions<config extends Config>(
   config: config,

package/src/query/signTypedData.ts

@@ -8,7 +8,7 @@ import {
   signTypedData,
 } from '../actions/signTypedData.js'
 import { type Config } from '../createConfig.js'
-import type { Evaluate } from '../types/utils.js'
+import { type Evaluate } from '../types/utils.js'
 
 export function signTypedDataMutationOptions<config extends Config>(
   config: config,

package/src/query/simulateContract.ts

@@ -7,7 +7,7 @@ import {
   type SimulateContractReturnType,
   simulateContract,
 } from '../actions/simulateContract.js'
-import type { Config } from '../createConfig.js'
+import { type Config } from '../createConfig.js'
 import type { UnionPartial } from '../types/utils.js'
 import type { ScopeKeyParameter } from './types.js'
 import { filterQueryOptions } from './utils.js'

package/src/query/switchAccount.ts

@@ -1,4 +1,4 @@
-import type { MutationOptions } from '@tanstack/query-core'
+import { type MutationOptions } from '@tanstack/query-core'
 
 import {
   type SwitchAccountErrorType,
@@ -7,8 +7,8 @@ import {
   switchAccount,
 } from '../actions/switchAccount.js'
 import { type Config } from '../createConfig.js'
-import type { Evaluate } from '../types/utils.js'
-import type { Mutate, MutateAsync } from './types.js'
+import { type Evaluate } from '../types/utils.js'
+import { type Mutate, type MutateAsync } from './types.js'
 
 export function switchAccountMutationOptions<config extends Config>(
   config: config,