feat: unstable_connector transport

packages/connectors/src/coinbaseWallet.ts

@@ -53,6 +53,7 @@ export function coinbaseWallet(parameters: CoinbaseWalletParameters) {
   return createConnector<Provider, Properties>((config) => ({
     id: 'coinbaseWalletSDK',
     name: 'Coinbase Wallet',
+    type: 'coinbaseWallet',
     async connect({ chainId } = {}) {
       try {
         const provider = await this.getProvider()

packages/connectors/src/ledger.ts

@@ -40,6 +40,7 @@ export function ledger(parameters: LedgerParameters = {}) {
   return createConnector<Provider, Properties>((config) => ({
     id: 'ledger',
     name: 'Ledger',
+    type: 'ledger',
     async setup() {
       const provider = await this.getProvider().catch(() => null)
       if (!provider) return

packages/connectors/src/metaMask.ts

@@ -49,6 +49,7 @@ export function metaMask(parameters: MetaMaskParameters = {}) {
   return createConnector<Provider, Properties, StorageItem>((config) => ({
     id: 'metaMaskSDK',
     name: 'MetaMask',
+    type: 'metaMask',
     async setup() {
       const provider = await this.getProvider()
       if (provider)

packages/connectors/src/safe.ts

@@ -42,6 +42,7 @@ export function safe(parameters: SafeParameters = {}) {
   return createConnector<Provider, Properties, StorageItem>((config) => ({
     id: 'safe',
     name: 'Safe',
+    type: 'safe',
     async connect() {
       const provider = await this.getProvider()
       if (!provider) throw new ProviderNotFoundError()

packages/connectors/src/walletConnect.ts

@@ -104,6 +104,7 @@ export function walletConnect(parameters: WalletConnectParameters) {
   return createConnector<Provider, Properties, StorageItem>((config) => ({
     id: 'walletConnect',
     name: 'WalletConnect',
+    type: 'walletConnect',
     async setup() {
       const provider = await this.getProvider().catch(() => null)
       if (!provider) return

packages/core/src/actions/connect.test.ts

@@ -57,7 +57,7 @@ test('behavior: user rejected request', async () => {
     [UserRejectedRequestError: User rejected the request.
 
     Details: Failed to connect.
-    Version: [email protected].9]
+    Version: [email protected].11]
   `)
 })
 

packages/core/src/actions/getToken.test.ts

@@ -79,6 +79,6 @@ test('behavior: bogus token', async () => {
       function:  decimals()
 
     Docs: https://viem.sh/docs/contract/multicall.html
-    Version: [email protected].9"
+    Version: [email protected].11"
   `)
 })

packages/core/src/actions/readContracts.test.ts

@@ -397,7 +397,7 @@ test('throws if allowFailure=false & a contract method fails', async () => {
       args:                         (0xA0Cf798816D4b9b9866b5330EEa46a18382f251e, 69420)
 
     Docs: https://viem.sh/docs/contract/readContract.html
-    Version: [email protected].9"
+    Version: [email protected].11"
   `,
   )
 })
@@ -450,7 +450,7 @@ test('allowFailure=true & a contract method fails', async () => {
       args:                         (0xA0Cf798816D4b9b9866b5330EEa46a18382f251e, 69420)
 
     Docs: https://viem.sh/docs/contract/readContract.html
-    Version: [email protected].9],
+    Version: [email protected].11],
         "result": undefined,
         "status": "failure",
       },
@@ -464,7 +464,7 @@ test('allowFailure=true & a contract method fails', async () => {
       args:                         (0xA0Cf798816D4b9b9866b5330EEa46a18382f251e, 69421)
 
     Docs: https://viem.sh/docs/contract/readContract.html
-    Version: [email protected].9],
+    Version: [email protected].11],
         "result": undefined,
         "status": "failure",
       },
@@ -502,7 +502,7 @@ test('throws if allowFailure=false & encoding contract function data fails', asy
       args:             (1e+31)
 
     Docs: https://viem.sh/docs/contract/readContract.html
-    Version: [email protected].9"
+    Version: [email protected].11"
   `,
   )
 })
@@ -561,7 +561,7 @@ test('allowFailure=true & encoding contract function data fails', async () => {
       args:             (1e+31)
 
     Docs: https://viem.sh/docs/contract/readContract.html
-    Version: [email protected].9],
+    Version: [email protected].11],
         "result": undefined,
         "status": "failure",
       },
@@ -579,7 +579,7 @@ test('allowFailure=true & encoding contract function data fails', async () => {
       args:             (1e+31)
 
     Docs: https://viem.sh/docs/contract/readContract.html
-    Version: [email protected].9],
+    Version: [email protected].11],
         "result": undefined,
         "status": "failure",
       },
@@ -617,7 +617,7 @@ test('should throw if allowFailure=false & a contract has no response', async ()
       args:          (0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC)
 
     Docs: https://viem.sh/docs/contract/readContract.html
-    Version: [email protected].9"
+    Version: [email protected].11"
   `,
   )
 })
@@ -669,7 +669,7 @@ test('allowFailure=true & a contract has no response', async () => {
       args:          (0xa5cc3c03994DB5b0d9A5eEdD10CabaB0813678AC)
 
     Docs: https://viem.sh/docs/contract/readContract.html
-    Version: [email protected].9],
+    Version: [email protected].11],
         "result": undefined,
         "status": "failure",
       },

packages/core/src/actions/signMessage.test.ts

@@ -36,7 +36,7 @@ test('behavior: user rejected request', async () => {
     [UserRejectedRequestError: User rejected the request.
 
     Details: Failed to sign message.
-    Version: [email protected].9]
+    Version: [email protected].11]
   `)
   await disconnect(config, { connector: connector_ })
 })

packages/core/src/actions/signTypedData.test.ts

@@ -46,7 +46,7 @@ test('behavior: user rejected request', async () => {
     [UserRejectedRequestError: User rejected the request.
 
     Details: Failed to sign typed data.
-    Version: [email protected].9]
+    Version: [email protected].11]
   `)
   await disconnect(config, { connector: connector_ })
 })

packages/core/src/actions/switchChain.test.ts

@@ -43,7 +43,7 @@ test('behavior: user rejected request', async () => {
     [UserRejectedRequestError: User rejected the request.
 
     Details: Failed to switch chain.
-    Version: [email protected].9]
+    Version: [email protected].11]
   `)
   await disconnect(config, { connector: connector_ })
 })

packages/core/src/connectors/createConnector.test.ts

@@ -7,6 +7,7 @@ test('default', () => {
     return {
       id: 'test',
       name: 'Test Connector',
+      type: 'test',
       async setup() {},
       async connect() {
         return { accounts: [] as Address[], chainId: 123 }

packages/core/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(

packages/core/src/connectors/injected.ts

@@ -132,6 +132,7 @@ export function injected(parameters: InjectedParameters = {}) {
     get name() {
       return getTarget().name
     },
+    type: 'injected',
     async setup() {
       const provider = await this.getProvider()
       // Only start listening for events if `target` is set, otherwise `injected()` will also receive events

packages/core/src/connectors/mock.ts

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

packages/core/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: connectors.getState(),
+          }),
       })
     }
 
@@ -443,6 +447,10 @@ export type Connector = ReturnType<CreateConnectorFn> & {
   uid: string
 }
 
+export type Transport = (
+  params: Parameters<viem_Transport>[0] & { connectors?: Connector[] },
+) => ReturnType<viem_Transport>
+
 type ClientConfig = LooseOmit<
   viem_ClientConfig,
   'account' | 'chain' | 'key' | 'name' | 'transport' | 'type'

packages/core/src/exports/index.test.ts

@@ -5,10 +5,6 @@ import * as core from './index.js'
 test('exports', () => {
   expect(Object.keys(core)).toMatchInlineSnapshot(`
     [
-      "custom",
-      "fallback",
-      "http",
-      "webSocket",
       "connect",
       "disconnect",
       "estimateGas",
@@ -75,6 +71,11 @@ test('exports', () => {
       "ConnectorAccountNotFoundError",
       "ProviderNotFoundError",
       "SwitchChainNotSupportedError",
+      "custom",
+      "http",
+      "webSocket",
+      "unstable_connector",
+      "fallback",
       "cookieStorage",
       "cookieToInitialState",
       "parseCookie",

packages/core/src/exports/index.ts

@@ -1,14 +1,3 @@
-////////////////////////////////////////////////////////////////////////////////
-// Viem
-
-// extremely commonly used viem exports
-export {
-  custom,
-  fallback,
-  http,
-  webSocket,
-} from 'viem'
-
 ////////////////////////////////////////////////////////////////////////////////
 // Actions
 
@@ -374,6 +363,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
 

packages/core/src/transports/connector.test.ts

@@ -0,0 +1,20 @@
+import { expect, test } from 'vitest'
+import { unstable_connector } from './connector.js'
+
+test('setup', () => {
+  expect(unstable_connector({ type: 'injected' })({})).toMatchInlineSnapshot(`
+    {
+      "config": {
+        "key": "connector",
+        "name": "Connector",
+        "request": [Function],
+        "retryCount": 3,
+        "retryDelay": 150,
+        "timeout": undefined,
+        "type": "connector",
+      },
+      "request": [Function],
+      "value": undefined,
+    }
+  `)
+})

packages/core/src/transports/connector.ts

@@ -0,0 +1,84 @@
+import {
+  ChainDisconnectedError,
+  type EIP1193Provider,
+  ProviderDisconnectedError,
+  type TransportConfig,
+  createTransport,
+  hexToNumber,
+} from 'viem'
+import type { 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']
+  /** Type of connector to target. */
+  type?:
+    | 'injected'
+    | 'coinbase'
+    | 'ledger'
+    | 'metaMask'
+    | 'safe'
+    | 'walletConnect'
+    | (string & {})
+}
+
+export type ConnectorTransport = Transport
+
+export function unstable_connector(
+  config: ConnectorTransportConfig,
+): Transport {
+  const {
+    key = 'connector',
+    name = 'Connector',
+    retryCount,
+    retryDelay,
+    type,
+  } = config || {}
+  return ({ chain, connectors, retryCount: defaultRetryCount }) => {
+    const connector = connectors?.find((c) => c.type === type)
+    return createTransport({
+      key,
+      name,
+      async request({ method, params }) {
+        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.'),
+          )
+
+        const chainId = hexToNumber(
+          await provider.request({ method: 'eth_chainId' }),
+        )
+        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',
+    })
+  }
+}