WebSocket Transport
The webSocket Transport connects to a JSON-RPC API via a WebSocket.
Import
ts
import { webSocket } from 'viem'import { webSocket } from 'viem'Usage
ts
import { createPublicClient, webSocket } from 'viem'
import { mainnet } from 'viem/chains'
const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...')
const client = createPublicClient({
chain: mainnet,
transport,
})import { createPublicClient, webSocket } from 'viem'
import { mainnet } from 'viem/chains'
const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...')
const client = createPublicClient({
chain: mainnet,
transport,
})WARNING
If no url is provided, then the transport will fall back to a public RPC URL on the chain. It is highly recommended to provide an authenticated RPC URL to prevent rate-limiting.
Parameters
url
- Type:
string
URL of the JSON-RPC API.
ts
const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...')const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...')key (optional)
- Type:
string - Default:
"webSocket"
A key for the Transport.
ts
const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...', {
key: 'alchemy',
})const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...', {
key: 'alchemy',
})name (optional)
- Type:
string - Default:
"WebSocket JSON-RPC"
A name for the Transport
ts
const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...', {
name: 'Alchemy WebSocket Provider',
})const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...', {
name: 'Alchemy WebSocket Provider',
})retryCount (optional)
- Type:
number - Default:
3
The max number of times to retry when a request fails.
ts
const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...', {
retryCount: 5,
})const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...', {
retryCount: 5,
})retryDelay (optional)
- Type:
number - Default:
150
The base delay (in ms) between retries. By default, the Transport will use exponential backoff (~~(1 << count) * retryDelay), which means the time between retries is not constant.
ts
const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...', {
retryDelay: 100,
})const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...', {
retryDelay: 100,
})timeout (optional)
- Type:
number - Default:
10_000
The timeout for async WebSocket requests.
ts
const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...', {
timeout: 60_000,
})const transport = webSocket('wss://eth-mainnet.g.alchemy.com/v2/...', {
timeout: 60_000,
})