@wagmi/core 2.0.0-alpha.4 → 2.0.0-alpha.5

package/src/actions/watchBlockNumber.ts

@@ -66,9 +66,7 @@ export function watchBlockNumber<
   if (syncConnectedChain && !parameters.chainId)
     unsubscribe = config.subscribe(
       ({ chainId }) => chainId,
-      async (chainId) => {
-        return listener(chainId)
-      },
+      async (chainId) => listener(chainId),
     )
 
   return () => {

package/src/actions/watchBlocks.ts

@@ -75,9 +75,7 @@ export function watchBlocks<
   if (syncConnectedChain && !parameters.chainId)
     unsubscribe = config.subscribe(
       ({ chainId }) => chainId,
-      async (chainId) => {
-        return listener(chainId)
-      },
+      async (chainId) => listener(chainId),
     )
 
   return () => {

package/src/actions/watchContractEvent.ts

@@ -86,9 +86,7 @@ export function watchContractEvent<
   if (syncConnectedChain && !parameters.chainId)
     unsubscribe = config.subscribe(
       ({ chainId }) => chainId,
-      async (chainId) => {
-        return listener(chainId)
-      },
+      async (chainId) => listener(chainId),
     )
 
   return () => {

package/src/actions/watchPendingTransactions.ts

@@ -67,9 +67,7 @@ export function watchPendingTransactions<
   if (syncConnectedChain && !parameters.chainId)
     unsubscribe = config.subscribe(
       ({ chainId }) => chainId,
-      async (chainId) => {
-        return listener(chainId)
-      },
+      async (chainId) => listener(chainId),
     )
 
   return () => {

package/src/actions/writeContract.ts

@@ -15,7 +15,7 @@ import type {
   ChainIdParameter,
   ConnectorParameter,
 } from '../types/properties.js'
-import type { Evaluate, UnionOmit } from '../types/utils.js'
+import type { Evaluate, UnionEvaluate, UnionOmit } from '../types/utils.js'
 import { assertActiveChain } from '../utils/assertActiveChain.js'
 import { getConnectorClient } from './getConnectorClient.js'
 import {
@@ -39,22 +39,24 @@ export type WriteContractParameters<
   ///
   allFunctionNames = ContractFunctionName<abi, 'nonpayable' | 'payable'>,
   chains extends readonly Chain[] = SelectChains<config, chainId>,
-> = {
-  [key in keyof chains]: UnionOmit<
-    viem_WriteContractParameters<
-      abi,
-      functionName,
-      args,
-      chains[key],
-      Account,
-      chains[key],
-      allFunctionNames
-    >,
-    'chain'
-  >
-}[number] &
-  Evaluate<ChainIdParameter<config, chainId>> &
-  ConnectorParameter & { __mode?: 'prepared' }
+> = UnionEvaluate<
+  {
+    [key in keyof chains]: UnionOmit<
+      viem_WriteContractParameters<
+        abi,
+        functionName,
+        args,
+        chains[key],
+        Account,
+        chains[key],
+        allFunctionNames
+      >,
+      'chain'
+    >
+  }[number] &
+    Evaluate<ChainIdParameter<config, chainId>> &
+    ConnectorParameter & { __mode?: 'prepared' }
+>
 
 export type WriteContractReturnType = viem_WriteContractReturnType
 
@@ -91,13 +93,7 @@ export async function writeContract<
   } else {
     const { request: simulateRequest } = await simulateContract(
       config,
-      rest as unknown as SimulateContractParameters<
-        abi,
-        functionName,
-        args,
-        config,
-        chainId
-      >,
+      rest as SimulateContractParameters,
     )
     request = simulateRequest
   }

package/src/connectors/injected.ts

@@ -122,7 +122,9 @@ export function injected(parameters: InjectedParameters = {}) {
   type Properties = {
     onConnect(connectInfo: ProviderConnectInfo): void
   }
-  type StorageItem = { [_ in `${string}.disconnected`]: true }
+  type StorageItem = {
+    [_ in 'injected.connected' | `${string}.disconnected`]: true
+  }
 
   return createConnector<Provider, Properties, StorageItem>((config) => ({
     get icon() {
@@ -137,9 +139,8 @@ export function injected(parameters: InjectedParameters = {}) {
     async setup() {
       const provider = await this.getProvider()
       // Only start listening for events if `target` is set, otherwise `injected()` will also receive events
-      if (provider && parameters.target) {
+      if (provider && parameters.target)
         provider.on('connect', this.onConnect.bind(this))
-      }
     },
     async connect({ chainId, isReconnecting } = {}) {
       const provider = await this.getProvider()
@@ -190,9 +191,13 @@ export function injected(parameters: InjectedParameters = {}) {
           currentChainId = chain?.id ?? currentChainId
         }
 
-        // Remove disconnected shim if it exists
-        if (shimDisconnect)
+        if (shimDisconnect) {
+          // Remove disconnected shim if it exists
           await config.storage?.removeItem(`${this.id}.disconnected`)
+          // Add connected shim if no target exists
+          if (!parameters.target)
+            await config.storage?.setItem('injected.connected', true)
+        }
 
         return { accounts, chainId: currentChainId }
       } catch (err) {
@@ -217,8 +222,11 @@ export function injected(parameters: InjectedParameters = {}) {
       provider.on('connect', this.onConnect.bind(this))
 
       // Add shim signalling connector is disconnected
-      if (shimDisconnect)
+      if (shimDisconnect) {
         await config.storage?.setItem(`${this.id}.disconnected`, true)
+        if (!parameters.target)
+          await config.storage?.removeItem('injected.connected')
+      }
     },
     async getAccounts() {
       const provider = await this.getProvider()
@@ -249,6 +257,15 @@ export function injected(parameters: InjectedParameters = {}) {
           (await config.storage?.getItem(`${this.id}.disconnected`))
         if (isDisconnected) return false
 
+        // Don't allow injected connector to connect if no target is set and it hasn't already connected
+        // (e.g. flag in storage is not set). This prevents a targetless injected connector from connecting
+        // automatically whenever there is a targeted connector configured.
+        if (!parameters.target) {
+          const connected = await config.storage?.getItem('injected.connected')
+          console.log({ connected })
+          if (!connected) return false
+        }
+
         const provider = await this.getProvider()
         if (!provider) {
           if (

package/src/connectors/mock.ts

@@ -0,0 +1,174 @@
+import {
+  type Address,
+  type EIP1193RequestFn,
+  type Hex,
+  RpcRequestError,
+  SwitchChainError,
+  type Transport,
+  UserRejectedRequestError,
+  type WalletRpcSchema,
+  custom,
+  fromHex,
+  getAddress,
+  numberToHex,
+} from 'viem'
+import { rpc } from 'viem/utils'
+
+import {
+  ChainNotConfiguredError,
+  ConnectorNotConnectedError,
+} from '../errors/config.js'
+import { normalizeChainId } from '../utils/normalizeChainId.js'
+import { createConnector } from './createConnector.js'
+
+export type MockParameters = {
+  accounts: readonly [Address, ...Address[]]
+  features?:
+    | {
+        connectError?: boolean | Error | undefined
+        switchChainError?: boolean | Error | undefined
+        signMessageError?: boolean | Error | undefined
+        signTypedDataError?: boolean | Error | undefined
+        reconnect?: boolean | undefined
+      }
+    | undefined
+}
+
+export function mock(parameters: MockParameters) {
+  const features = parameters.features ?? {}
+
+  type Provider = ReturnType<
+    Transport<'custom', {}, EIP1193RequestFn<WalletRpcSchema>>
+  >
+  let connected = false
+  let connectedChainId: number
+
+  return createConnector<Provider>((config) => ({
+    id: 'mock',
+    name: 'Mock Connector',
+    async setup() {
+      connectedChainId = config.chains[0].id
+    },
+    async connect({ chainId } = {}) {
+      if (features.connectError) {
+        if (typeof features.connectError === 'boolean')
+          throw new UserRejectedRequestError(new Error('Failed to connect.'))
+        throw features.connectError
+      }
+
+      const provider = await this.getProvider()
+      const accounts = await provider.request({
+        method: 'eth_requestAccounts',
+      })
+
+      let currentChainId = await this.getChainId()
+      if (chainId && currentChainId !== chainId) {
+        const chain = await this.switchChain!({ chainId })
+        currentChainId = chain.id
+      }
+
+      connected = true
+
+      return { accounts, chainId: currentChainId }
+    },
+    async disconnect() {
+      connected = false
+    },
+    async getAccounts() {
+      if (!connected) throw new ConnectorNotConnectedError()
+      const provider = await this.getProvider()
+      const accounts = await provider.request({ method: 'eth_accounts' })
+      return accounts.map(getAddress)
+    },
+    async getChainId() {
+      const provider = await this.getProvider()
+      const hexChainId = await provider.request({ method: 'eth_chainId' })
+      return fromHex(hexChainId, 'number')
+    },
+    async isAuthorized() {
+      if (!features.reconnect) return false
+      if (!connected) return false
+      const accounts = await this.getAccounts()
+      return !!accounts.length
+    },
+    async switchChain({ chainId }) {
+      const provider = await this.getProvider()
+      const chain = config.chains.find((x) => x.id === chainId)
+      if (!chain) throw new SwitchChainError(new ChainNotConfiguredError())
+
+      await provider.request({
+        method: 'wallet_switchEthereumChain',
+        params: [{ chainId: numberToHex(chainId) }],
+      })
+      return chain
+    },
+    onAccountsChanged(accounts) {
+      if (accounts.length === 0) this.onDisconnect()
+      else config.emitter.emit('change', { accounts: accounts.map(getAddress) })
+    },
+    onChainChanged(chain) {
+      const chainId = normalizeChainId(chain)
+      config.emitter.emit('change', { chainId })
+    },
+    async onDisconnect(_error) {
+      config.emitter.emit('disconnect')
+      connected = false
+    },
+    async getProvider({ chainId } = {}) {
+      const chain =
+        config.chains.find((x) => x.id === chainId) ?? config.chains[0]
+      const url = chain.rpcUrls.default.http[0]!
+
+      const request: EIP1193RequestFn = async ({ method, params }) => {
+        // eth methods
+        if (method === 'eth_chainId') return numberToHex(connectedChainId)
+        if (method === 'eth_requestAccounts') return parameters.accounts
+        if (method === 'eth_signTypedData_v4')
+          if (features.signTypedDataError) {
+            if (typeof features.signTypedDataError === 'boolean')
+              throw new UserRejectedRequestError(
+                new Error('Failed to sign typed data.'),
+              )
+            throw features.signTypedDataError
+          }
+
+        // wallet methods
+        if (method === 'wallet_switchEthereumChain') {
+          if (features.switchChainError) {
+            if (typeof features.switchChainError === 'boolean')
+              throw new UserRejectedRequestError(
+                new Error('Failed to switch chain.'),
+              )
+            throw features.switchChainError
+          }
+          type Params = [{ chainId: Hex }]
+          connectedChainId = fromHex((params as Params)[0].chainId, 'number')
+          this.onChainChanged(connectedChainId.toString())
+          return
+        }
+
+        // other methods
+        if (method === 'personal_sign') {
+          if (features.signMessageError) {
+            if (typeof features.signMessageError === 'boolean')
+              throw new UserRejectedRequestError(
+                new Error('Failed to sign message.'),
+              )
+            throw features.signMessageError
+          }
+          // Change `personal_sign` to `eth_sign` and swap params
+          method = 'eth_sign'
+          type Params = [data: Hex, address: Address]
+          params = [(params as Params)[1], (params as Params)[0]]
+        }
+
+        const body = { method, params }
+        const { error, result } = await rpc.http(url, { body })
+        if (error) throw new RpcRequestError({ body, error, url })
+
+        return result
+      }
+      return custom({ request })({ retryCount: 0 })
+    },
+  }))
+}

package/src/createConfig.ts

@@ -115,7 +115,6 @@ export function createConfig<
     const chain = chains.find((x) => x.id === chainId)
 
     // If the target chain is not configured, use the client of the current chain.
-    // TODO: should we error instead? idk. figure out later.
     type Return = Client<Transport, Extract<chains[number], { id: chainId }>>
     {
       const client = clients.get(store.getState().chainId)
@@ -313,7 +312,7 @@ export function createConfig<
         selector as unknown as (state: State) => any,
         listener,
         options
-          ? { ...options, fireImmediately: options.emitOnBegin }
+          ? { ...options, fireImmediately: options.emitImmediately }
           : undefined,
       )
     },
@@ -359,7 +358,7 @@ export type Config<
     listener: (state: state, previousState: state) => void,
     options?:
       | {
-          emitOnBegin?: boolean | undefined
+          emitImmediately?: boolean | undefined
           equalityFn?: ((a: state, b: state) => boolean) | undefined
         }
       | undefined,

package/src/exports/actions.ts

@@ -15,13 +15,6 @@ export {
   disconnect,
 } from '../actions/disconnect.js'
 
-export {
-  type EstimateFeesPerGasError,
-  type EstimateFeesPerGasParameters,
-  type EstimateFeesPerGasReturnType,
-  estimateFeesPerGas,
-} from '../actions/estimateFeesPerGas.js'
-
 export {
   type EstimateGasError,
   type EstimateGasParameters,
@@ -29,6 +22,13 @@ export {
   estimateGas,
 } from '../actions/estimateGas.js'
 
+export {
+  type EstimateFeesPerGasError,
+  type EstimateFeesPerGasParameters,
+  type EstimateFeesPerGasReturnType,
+  estimateFeesPerGas,
+} from '../actions/estimateFeesPerGas.js'
+
 export {
   type GetAccountReturnType,
   getAccount,
@@ -39,13 +39,24 @@ export {
   type GetBalanceReturnType,
   type GetBalanceError,
   getBalance,
+  /** @deprecated use `getBalance` instead */
+  getBalance as fetchBalance,
 } from '../actions/getBalance.js'
 
+export {
+  type GetBlockError,
+  type GetBlockParameters,
+  type GetBlockReturnType,
+  getBlock,
+} from '../actions/getBlock.js'
+
 export {
   type GetBlockNumberError,
   type GetBlockNumberParameters,
   type GetBlockNumberReturnType,
   getBlockNumber,
+  /** @deprecated use `getBlockNumber` instead */
+  getBlockNumber as fetchBlockNumber,
 } from '../actions/getBlockNumber.js'
 
 export {
@@ -81,6 +92,8 @@ export {
   type GetEnsAddressParameters,
   type GetEnsAddressReturnType,
   getEnsAddress,
+  /** @deprecated use `getEnsAddress` instead */
+  getEnsAddress as fetchEnsAddress,
 } from '../actions/getEnsAddress.js'
 
 export {
@@ -88,6 +101,8 @@ export {
   type GetEnsAvatarParameters,
   type GetEnsAvatarReturnType,
   getEnsAvatar,
+  /** @deprecated use `getEnsAvatar` instead */
+  getEnsAvatar as fetchEnsAvatar,
 } from '../actions/getEnsAvatar.js'
 
 export {
@@ -95,6 +110,8 @@ export {
   type GetEnsNameParameters,
   type GetEnsNameReturnType,
   getEnsName,
+  /** @deprecated */
+  getEnsName as fetchEnsName,
 } from '../actions/getEnsName.js'
 
 export {
@@ -102,6 +119,8 @@ export {
   type GetEnsResolverParameters,
   type GetEnsResolverReturnType,
   getEnsResolver,
+  /** @deprecated use `getEnsResolver` instead */
+  getEnsResolver as fetchEnsResolver,
 } from '../actions/getEnsResolver.js'
 
 export {
@@ -115,6 +134,8 @@ export {
   type GetTokenParameters,
   type GetTokenReturnType,
   getToken,
+  /** @deprecated use `getToken` instead */
+  getToken as fetchToken,
 } from '../actions/getToken.js'
 
 export {
@@ -122,6 +143,8 @@ export {
   type GetTransactionParameters,
   type GetTransactionReturnType,
   getTransaction,
+  /** @deprecated use `getTransaction` instead */
+  getTransaction as fetchTransaction,
 } from '../actions/getTransaction.js'
 
 export {
@@ -198,6 +221,8 @@ export {
   type SwitchChainParameters,
   type SwitchChainReturnType,
   switchChain,
+  /** @deprecated use `switchChain` instead */
+  switchChain as switchNetwork,
 } from '../actions/switchChain.js'
 
 export {
@@ -206,6 +231,12 @@ export {
   watchAccount,
 } from '../actions/watchAccount.js'
 
+export {
+  type WatchBlocksParameters,
+  type WatchBlocksReturnType,
+  watchBlocks,
+} from '../actions/watchBlocks.js'
+
 export {
   type WatchBlockNumberParameters,
   type WatchBlockNumberReturnType,
@@ -259,6 +290,8 @@ export {
   type WaitForTransactionReceiptParameters,
   type WaitForTransactionReceiptReturnType,
   waitForTransactionReceipt,
+  /** @deprecated use `waitForTransactionReceipt` instead */
+  waitForTransactionReceipt as waitForTransaction,
 } from '../actions/waitForTransactionReceipt.js'
 
 export {

package/src/exports/index.ts

@@ -50,6 +50,8 @@ export {
   type GetBalanceReturnType,
   type GetBalanceError,
   getBalance,
+  /** @deprecated use `getBalance` instead */
+  getBalance as fetchBalance,
 } from '../actions/getBalance.js'
 
 export {
@@ -64,6 +66,8 @@ export {
   type GetBlockNumberParameters,
   type GetBlockNumberReturnType,
   getBlockNumber,
+  /** @deprecated use `getBlockNumber` instead */
+  getBlockNumber as fetchBlockNumber,
 } from '../actions/getBlockNumber.js'
 
 export {
@@ -99,6 +103,8 @@ export {
   type GetEnsAddressParameters,
   type GetEnsAddressReturnType,
   getEnsAddress,
+  /** @deprecated use `getEnsAddress` instead */
+  getEnsAddress as fetchEnsAddress,
 } from '../actions/getEnsAddress.js'
 
 export {
@@ -106,6 +112,8 @@ export {
   type GetEnsAvatarParameters,
   type GetEnsAvatarReturnType,
   getEnsAvatar,
+  /** @deprecated use `getEnsAvatar` instead */
+  getEnsAvatar as fetchEnsAvatar,
 } from '../actions/getEnsAvatar.js'
 
 export {
@@ -113,6 +121,8 @@ export {
   type GetEnsNameParameters,
   type GetEnsNameReturnType,
   getEnsName,
+  /** @deprecated */
+  getEnsName as fetchEnsName,
 } from '../actions/getEnsName.js'
 
 export {
@@ -120,6 +130,8 @@ export {
   type GetEnsResolverParameters,
   type GetEnsResolverReturnType,
   getEnsResolver,
+  /** @deprecated use `getEnsResolver` instead */
+  getEnsResolver as fetchEnsResolver,
 } from '../actions/getEnsResolver.js'
 
 export {
@@ -133,6 +145,8 @@ export {
   type GetTokenParameters,
   type GetTokenReturnType,
   getToken,
+  /** @deprecated use `getToken` instead */
+  getToken as fetchToken,
 } from '../actions/getToken.js'
 
 export {
@@ -140,6 +154,8 @@ export {
   type GetTransactionParameters,
   type GetTransactionReturnType,
   getTransaction,
+  /** @deprecated use `getTransaction` instead */
+  getTransaction as fetchTransaction,
 } from '../actions/getTransaction.js'
 
 export {
@@ -216,6 +232,8 @@ export {
   type SwitchChainParameters,
   type SwitchChainReturnType,
   switchChain,
+  /** @deprecated use `switchChain` instead */
+  switchChain as switchNetwork,
 } from '../actions/switchChain.js'
 
 export {
@@ -283,6 +301,8 @@ export {
   type WaitForTransactionReceiptParameters,
   type WaitForTransactionReceiptReturnType,
   waitForTransactionReceipt,
+  /** @deprecated use `waitForTransactionReceipt` instead */
+  waitForTransactionReceipt as waitForTransaction,
 } from '../actions/waitForTransactionReceipt.js'
 
 export {
@@ -295,11 +315,6 @@ export {
 ////////////////////////////////////////////////////////////////////////////////
 // connectors
 
-export {
-  type InjectedParameters,
-  injected,
-} from '../connectors/injected.js'
-
 export {
   type ConnectorEventMap,
   type CreateConnectorFn,
@@ -356,6 +371,8 @@ export { type Register, type ResolvedRegister } from '../types/register.js'
 ////////////////////////////////////////////////////////////////////////////////
 // Utilities
 
+export { deepEqual } from '../utils/deepEqual.js'
+
 export { deserialize } from '../utils/deserialize.js'
 
 export { normalizeChainId } from '../utils/normalizeChainId.js'

package/src/exports/internal.ts

@@ -1,3 +1,16 @@
+////////////////////////////////////////////////////////////////////////////////
+// Connectors
+
+export {
+  type InjectedParameters,
+  injected,
+} from '../connectors/injected.js'
+
+export {
+  type MockParameters,
+  mock,
+} from '../connectors/mock.js'
+
 ////////////////////////////////////////////////////////////////////////////////
 // Emitter
 

package/src/version.ts

@@ -1 +1 @@
-export const version = '2.0.0-alpha.4'
+export const version = '2.0.0-alpha.5'