@wagmi/core 2.0.0-beta.5 → 2.0.0-beta.6

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@wagmi/core",
   "description": "VanillaJS library for Ethereum",
-  "version": "2.0.0-beta.5",
+  "version": "2.0.0-beta.6",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/wagmi-dev/wagmi.git",
+    "url": "https://github.com/wevm/wagmi.git",
     "directory": "packages/core"
   },
   "files": [
@@ -66,7 +66,7 @@
   "peerDependencies": {
     "@tanstack/query-core": ">=5.0.0",
     "typescript": ">=5.0.4",
-    "viem": "2.0.0-beta.6"
+    "viem": "2.0.0-beta.15"
   },
   "peerDependenciesMeta": {
     "@tanstack/query-core": {
@@ -81,14 +81,11 @@
     "mipd": "^0.0.5",
     "zustand": "^4.4.1"
   },
-  "devDependencies": {
-    "@tanstack/query-core": "5.0.5"
-  },
   "contributors": [
-    "awkweb.eth <t@wagmi.sh>",
-    "jxom.eth <j@wagmi.sh>"
+    "awkweb.eth <t@wevm.dev>",
+    "jxom.eth <j@wevm.dev>"
   ],
-  "funding": "https://github.com/sponsors/wagmi-dev",
+  "funding": "https://github.com/sponsors/wevm",
   "keywords": [
     "wagmi",
     "eth",
@@ -96,12 +93,5 @@
     "dapps",
     "wallet",
     "web3"
-  ],
-  "scripts": {
-    "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",
-    "clean": "rm -rf dist tsconfig.tsbuildinfo actions chains internal query",
-    "test:build": "publint --strict",
-    "typecheck": "tsc --noEmit"
-  }
+  ]
 }

package/query/package.json.tmp

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

package/src/actions/disconnect.ts

@@ -1,14 +1,8 @@
-import {
-  type Config,
-  type Connection,
-  type Connector,
-} from '../createConfig.js'
+import type { Config, Connection, Connector } from '../createConfig.js'
 import type { BaseErrorType, ErrorType } from '../errors/base.js'
-import {
-  ConnectorNotConnectedError,
-  type ConnectorNotConnectedErrorType,
-  ConnectorNotFoundError,
-  type ConnectorNotFoundErrorType,
+import type {
+  ConnectorNotConnectedErrorType,
+  ConnectorNotFoundErrorType,
 } from '../errors/config.js'
 import type { ConnectorParameter } from '../types/properties.js'
 
@@ -36,16 +30,16 @@ export async function disconnect(
     connector = connection?.connector
   }
 
-  if (!connector) throw new ConnectorNotFoundError()
   const connections = config.state.connections
-  if (!connections.has(connector.uid)) throw new ConnectorNotConnectedError()
 
-  await connector.disconnect()
-  connector.emitter.off('change', config._internal.events.change)
-  connector.emitter.off('disconnect', config._internal.events.disconnect)
-  connector.emitter.on('connect', config._internal.events.connect)
+  if (connector) {
+    await connector.disconnect()
+    connector.emitter.off('change', config._internal.events.change)
+    connector.emitter.off('disconnect', config._internal.events.disconnect)
+    connector.emitter.on('connect', config._internal.events.connect)
 
-  connections.delete(connector.uid)
+    connections.delete(connector.uid)
+  }
 
   config.setState((x) => {
     // if no connections exist, move to disconnected state

package/src/actions/estimateGas.ts

@@ -28,7 +28,7 @@ export type EstimateGasParameters<
   chains extends readonly Chain[] = SelectChains<config, chainId>,
 > = {
   [key in keyof chains]: UnionEvaluate<
-    UnionLooseOmit<viem_EstimateGasParameters<chains[key], Account>, 'chain'> &
+    UnionLooseOmit<viem_EstimateGasParameters<chains[key]>, 'chain'> &
       ChainIdParameter<config, chainId> &
       ConnectorParameter
   >

package/src/actions/getBlock.ts

@@ -9,7 +9,7 @@ import {
 import { type Config } from '../createConfig.js'
 import type { SelectChains } from '../types/chain.js'
 import { type ChainIdParameter } from '../types/properties.js'
-import { type Evaluate } from '../types/utils.js'
+import { type Evaluate, type IsNarrowable } from '../types/utils.js'
 
 export type GetBlockParameters<
   includeTransactions extends boolean = false,
@@ -32,7 +32,7 @@ export type GetBlockReturnType<
 > = Evaluate<
   {
     [key in keyof chains]: viem_GetBlockReturnType<
-      chains[key],
+      IsNarrowable<chains[key], Chain> extends true ? chains[key] : undefined,
       includeTransactions,
       blockTag
     >

package/src/actions/getTransaction.ts

@@ -9,7 +9,7 @@ import {
 import { type Config } from '../createConfig.js'
 import type { SelectChains } from '../types/chain.js'
 import { type ChainIdParameter } from '../types/properties.js'
-import { type Evaluate } from '../types/utils.js'
+import { type Evaluate, type IsNarrowable } from '../types/utils.js'
 
 export type GetTransactionParameters<
   config extends Config = Config,
@@ -23,7 +23,9 @@ export type GetTransactionReturnType<
   chains extends readonly Chain[] = SelectChains<config, chainId>,
 > = Evaluate<
   {
-    [key in keyof chains]: viem_GetTransactionReturnType<chains[key]>
+    [key in keyof chains]: viem_GetTransactionReturnType<
+      IsNarrowable<chains[key], Chain> extends true ? chains[key] : undefined
+    >
   }[number]
 >
 

package/src/actions/getTransactionCount.ts

@@ -0,0 +1,31 @@
+import {
+  type GetTransactionCountErrorType as viem_GetTransactionCountErrorType,
+  type GetTransactionCountParameters as viem_GetTransactionCountParameters,
+  type GetTransactionCountReturnType as viem_GetTransactionCountReturnType,
+  getTransactionCount as viem_getTransactionCount,
+} from 'viem/actions'
+
+import { type Config } from '../createConfig.js'
+import { type ChainIdParameter } from '../types/properties.js'
+import { type Evaluate } from '../types/utils.js'
+
+export type GetTransactionCountParameters<config extends Config = Config> =
+  Evaluate<ChainIdParameter<config> & viem_GetTransactionCountParameters>
+
+export type GetTransactionCountReturnType = viem_GetTransactionCountReturnType
+
+export type GetTransactionCountErrorType = viem_GetTransactionCountErrorType
+
+/** https://beta.wagmi.sh/core/api/actions/getTransactionCount */
+export async function getTransactionCount<config extends Config>(
+  config: config,
+  parameters: GetTransactionCountParameters<config>,
+): Promise<GetTransactionCountReturnType> {
+  const { address, blockNumber, blockTag, chainId } = parameters
+
+  const client = config.getClient({ chainId })
+  return await viem_getTransactionCount(
+    client,
+    blockNumber ? { address, blockNumber } : { address, blockTag },
+  )
+}

package/src/actions/waitForTransactionReceipt.ts

@@ -12,7 +12,7 @@ import {
 import { type Config } from '../createConfig.js'
 import type { SelectChains } from '../types/chain.js'
 import { type ChainIdParameter } from '../types/properties.js'
-import { type Evaluate } from '../types/utils.js'
+import { type Evaluate, type IsNarrowable } from '../types/utils.js'
 
 export type WaitForTransactionReceiptParameters<
   config extends Config = Config,
@@ -28,7 +28,9 @@ export type WaitForTransactionReceiptReturnType<
   chains extends readonly Chain[] = SelectChains<config, chainId>,
 > = Evaluate<
   {
-    [key in keyof chains]: viem_WaitForTransactionReceiptReturnType<chains[key]>
+    [key in keyof chains]: viem_WaitForTransactionReceiptReturnType<
+      IsNarrowable<chains[key], Chain> extends true ? chains[key] : undefined
+    >
   }[number]
 >
 

package/src/actions/watchBlocks.ts

@@ -11,7 +11,7 @@ import type {
   ChainIdParameter,
   SyncConnectedChainParameter,
 } from '../types/properties.js'
-import type { UnionEvaluate } from '../types/utils.js'
+import type { IsNarrowable, UnionEvaluate } from '../types/utils.js'
 
 export type WatchBlocksParameters<
   includeTransactions extends boolean = false,
@@ -28,7 +28,7 @@ export type WatchBlocksParameters<
           ? WebSocketTransport
           : transport
         : WebSocketTransport,
-      chains[key],
+      IsNarrowable<chains[key], Chain> extends true ? chains[key] : undefined,
       includeTransactions,
       blockTag
     > &

package/src/actions/writeContract.ts

@@ -26,7 +26,6 @@ import {
 } from './getConnectorClient.js'
 import {
   type SimulateContractErrorType,
-  type SimulateContractParameters,
   simulateContract,
 } from './simulateContract.js'
 
@@ -106,7 +105,7 @@ export async function writeContract<
   else {
     const { request: simulateRequest } = await simulateContract(
       config,
-      rest as SimulateContractParameters,
+      rest as any,
     )
     request = simulateRequest
   }

package/src/connectors/createConnector.ts

@@ -34,6 +34,7 @@ export type CreateConnectorFn<
     readonly icon?: string | undefined
     readonly id: string
     readonly name: string
+    readonly type: string
 
     setup?(): Promise<void>
     connect(

package/src/connectors/injected.ts

@@ -9,6 +9,8 @@ import {
   UserRejectedRequestError,
   getAddress,
   numberToHex,
+  withRetry,
+  withTimeout,
 } from 'viem'
 
 import { ChainNotConfiguredError } from '../errors/config.js'
@@ -84,6 +86,7 @@ const targetMap = {
   },
 } as const satisfies TargetMap
 
+injected.type = 'injected' as const
 export function injected(parameters: InjectedParameters = {}) {
   const { shimDisconnect = true, unstable_shimAsyncInject } = parameters
 
@@ -132,6 +135,7 @@ export function injected(parameters: InjectedParameters = {}) {
     get name() {
       return getTarget().name
     },
+    type: injected.type,
     async setup() {
       const provider = await this.getProvider()
       // Only start listening for events if `target` is set, otherwise `injected()` will also receive events
@@ -268,7 +272,7 @@ export function injected(parameters: InjectedParameters = {}) {
             unstable_shimAsyncInject !== false
           ) {
             // If no provider is found, check for async injection
-            // https://github.com/wagmi-dev/references/issues/167
+            // https://github.com/wevm/references/issues/167
             // https://github.com/MetaMask/detect-provider
             const handleEthereum = async () => {
               if (typeof window !== 'undefined')
@@ -305,7 +309,13 @@ export function injected(parameters: InjectedParameters = {}) {
           throw new ProviderNotFoundError()
         }
 
-        const accounts = await this.getAccounts()
+        // We are applying a retry & timeout strategy here as some injected wallets (ie. MetaMask) fail to
+        // immediately resolve a JSON-RPC request on page load.
+        const accounts = await withRetry(() =>
+          withTimeout(() => this.getAccounts(), {
+            timeout: 100,
+          }),
+        )
         return !!accounts.length
       } catch {
         return false
@@ -359,7 +369,7 @@ export function injected(parameters: InjectedParameters = {}) {
                   chainId: numberToHex(chainId),
                   chainName: chain.name,
                   nativeCurrency: chain.nativeCurrency,
-                  rpcUrls: [chain.rpcUrls.public?.http[0] ?? ''],
+                  rpcUrls: [chain.rpcUrls.default?.http[0] ?? ''],
                   blockExplorerUrls,
                 },
               ],

package/src/connectors/mock.ts

@@ -34,6 +34,7 @@ export type MockParameters = {
     | undefined
 }
 
+mock.type = 'mock' as const
 export function mock(parameters: MockParameters) {
   const features = parameters.features ?? {}
 
@@ -46,6 +47,7 @@ export function mock(parameters: MockParameters) {
   return createConnector<Provider>((config) => ({
     id: 'mock',
     name: 'Mock Connector',
+    type: mock.type,
     async setup() {
       connectedChainId = config.chains[0].id
     },

package/src/createConfig.ts

@@ -8,7 +8,7 @@ import {
   type Chain,
   type Client,
   type ClientConfig as viem_ClientConfig,
-  type Transport,
+  type Transport as viem_Transport,
   createClient,
 } from 'viem'
 import { persist, subscribeWithSelector } from 'zustand/middleware'
@@ -155,7 +155,11 @@ export function createConfig<
         ...properties,
         chain,
         batch: properties.batch ?? { multicall: true },
-        transport: rest.transports[chainId],
+        transport: (parameters) =>
+          rest.transports[chainId]({
+            ...parameters,
+            connectors,
+          }),
       })
     }
 
@@ -443,6 +447,12 @@ export type Connector = ReturnType<CreateConnectorFn> & {
   uid: string
 }
 
+export type Transport = (
+  params: Parameters<viem_Transport>[0] & {
+    connectors?: StoreApi<Connector[]>
+  },
+) => ReturnType<viem_Transport>
+
 type ClientConfig = LooseOmit<
   viem_ClientConfig,
   'account' | 'chain' | 'key' | 'name' | 'transport' | 'type'

package/src/exports/actions.ts

@@ -147,6 +147,13 @@ export {
   getTransaction as fetchTransaction,
 } from '../actions/getTransaction.js'
 
+export {
+  type GetTransactionCountErrorType,
+  type GetTransactionCountParameters,
+  type GetTransactionCountReturnType,
+  getTransactionCount,
+} from '../actions/getTransactionCount.js'
+
 export {
   type GetWalletClientErrorType,
   type GetWalletClientParameters,

package/src/exports/index.ts

@@ -1,14 +1,3 @@
-////////////////////////////////////////////////////////////////////////////////
-// Viem
-
-// extremely commonly used viem exports
-export {
-  custom,
-  fallback,
-  http,
-  webSocket,
-} from 'viem'
-
 ////////////////////////////////////////////////////////////////////////////////
 // Actions
 
@@ -158,6 +147,13 @@ export {
   getTransaction as fetchTransaction,
 } from '../actions/getTransaction.js'
 
+export {
+  type GetTransactionCountErrorType,
+  type GetTransactionCountParameters,
+  type GetTransactionCountReturnType,
+  getTransactionCount,
+} from '../actions/getTransactionCount.js'
+
 export {
   type GetWalletClientErrorType,
   type GetWalletClientParameters,
@@ -374,6 +370,13 @@ export {
   SwitchChainNotSupportedError,
 } from '../errors/connector.js'
 
+////////////////////////////////////////////////////////////////////////////////
+// Transports
+
+export { custom, http, webSocket } from 'viem'
+export { unstable_connector } from '../transports/connector.js'
+export { fallback } from '../transports/fallback.js'
+
 ////////////////////////////////////////////////////////////////////////////////
 // Types
 

package/src/exports/query.ts

@@ -125,6 +125,15 @@ export {
   getTransactionQueryOptions,
 } from '../query/getTransaction.js'
 
+export {
+  type GetTransactionCountData,
+  type GetTransactionCountOptions,
+  type GetTransactionCountQueryFnData,
+  type GetTransactionCountQueryKey,
+  getTransactionCountQueryKey,
+  getTransactionCountQueryOptions,
+} from '../query/getTransactionCount.js'
+
 export {
   type GetWalletClientData,
   type GetWalletClientOptions,

package/src/query/getBlock.ts

@@ -38,7 +38,7 @@ export function getBlockQueryOptions<
     async queryFn({ queryKey }) {
       const { scopeKey: _, ...parameters } = queryKey[1]
       const block = await getBlock(config, parameters)
-      return block ?? null
+      return (block ?? null) as any
     },
     queryKey: getBlockQueryKey(options),
   } as const satisfies QueryOptions<

package/src/query/getTransactionCount.ts

@@ -0,0 +1,55 @@
+import { type QueryOptions } from '@tanstack/query-core'
+
+import {
+  type GetTransactionCountErrorType,
+  type GetTransactionCountParameters,
+  type GetTransactionCountReturnType,
+  getTransactionCount,
+} from '../actions/getTransactionCount.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'
+
+export type GetTransactionCountOptions<config extends Config> = Evaluate<
+  PartialBy<GetTransactionCountParameters<config>, 'address'> &
+    ScopeKeyParameter
+>
+
+export function getTransactionCountQueryOptions<config extends Config>(
+  config: config,
+  options: GetTransactionCountOptions<config> = {},
+) {
+  return {
+    async queryFn({ queryKey }) {
+      const { address, scopeKey: _, ...parameters } = queryKey[1]
+      if (!address) throw new Error('address is required')
+      const transactionCount = await getTransactionCount(config, {
+        ...(parameters as GetTransactionCountParameters),
+        address,
+      })
+      return transactionCount ?? null
+    },
+    queryKey: getTransactionCountQueryKey(options),
+  } as const satisfies QueryOptions<
+    GetTransactionCountQueryFnData,
+    GetTransactionCountErrorType,
+    GetTransactionCountData,
+    GetTransactionCountQueryKey<config>
+  >
+}
+
+export type GetTransactionCountQueryFnData =
+  Evaluate<GetTransactionCountReturnType>
+
+export type GetTransactionCountData = GetTransactionCountQueryFnData
+
+export function getTransactionCountQueryKey<config extends Config>(
+  options: GetTransactionCountOptions<config> = {},
+) {
+  return ['transactionCount', filterQueryOptions(options)] as const
+}
+
+export type GetTransactionCountQueryKey<config extends Config> = ReturnType<
+  typeof getTransactionCountQueryKey<config>
+>

package/src/transports/connector.ts

@@ -0,0 +1,83 @@
+import {
+  ChainDisconnectedError,
+  type EIP1193Provider,
+  ProviderDisconnectedError,
+  type TransportConfig,
+  createTransport,
+  hexToNumber,
+  withRetry,
+  withTimeout,
+} from 'viem'
+import type { Connector, Transport } from '../createConfig.js'
+
+export type ConnectorTransportConfig = {
+  /** The key of the transport. */
+  key?: TransportConfig['key']
+  /** The name of the transport. */
+  name?: TransportConfig['name']
+  /** The max number of times to retry. */
+  retryCount?: TransportConfig['retryCount']
+  /** The base delay (in ms) between retries. */
+  retryDelay?: TransportConfig['retryDelay']
+}
+
+export type ConnectorTransport = Transport
+
+export function unstable_connector(
+  connector: Pick<Connector, 'type'>,
+  config: ConnectorTransportConfig = {},
+): Transport {
+  const { type } = connector
+  const {
+    key = 'connector',
+    name = 'Connector',
+    retryCount,
+    retryDelay,
+  } = config
+  return ({ chain, connectors, retryCount: defaultRetryCount }) =>
+    createTransport({
+      key,
+      name,
+      async request({ method, params }) {
+        const connector = connectors?.getState().find((c) => c.type === type)
+        if (!connector)
+          throw new ProviderDisconnectedError(
+            new Error(
+              `Could not find connector of type "${type}" in \`connectors\` passed to \`createConfig\`.`,
+            ),
+          )
+
+        const provider = (await connector.getProvider({
+          chainId: chain?.id,
+        })) as EIP1193Provider | undefined
+        if (!provider)
+          throw new ProviderDisconnectedError(
+            new Error('Provider is disconnected.'),
+          )
+
+        // We are applying a retry & timeout strategy here as some injected wallets (ie. MetaMask) fail to
+        // immediately resolve a JSON-RPC request on page load.
+        const chainId = hexToNumber(
+          await withRetry(() =>
+            withTimeout(() => provider.request({ method: 'eth_chainId' }), {
+              timeout: 100,
+            }),
+          ),
+        )
+        if (chain && chainId !== chain.id)
+          throw new ChainDisconnectedError(
+            new Error(
+              `The current chain of the connector (id: ${chainId}) does not match the target chain for the request (id: ${chain.id} – ${chain.name}).`,
+            ),
+          )
+
+        return (await provider.request({
+          method,
+          params,
+        } as any)) as any
+      },
+      retryDelay,
+      retryCount: retryCount ?? defaultRetryCount,
+      type: 'connector',
+    })
+}

package/src/transports/fallback.ts

@@ -0,0 +1,9 @@
+import { fallback as viem_fallback } from 'viem'
+import type { Transport } from '../createConfig.js'
+
+export function fallback(
+  transports: Transport[],
+  config?: Parameters<typeof viem_fallback>[1],
+) {
+  return viem_fallback(transports, config)
+}

package/src/version.ts

@@ -1 +1 @@
-export const version = '2.0.0-beta.5'
+export const version = '2.0.0-beta.6'