http
The http Transport connects to a JSON-RPC API via HTTP. Wraps Viem's http Transport.
Import
import { http } from '@wagmi/core'import { http } from '@wagmi/core'Usage
import {
createConfig,
http
} from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'
export const config = createConfig({
chains: [mainnet, sepolia],
connectors: [injected()],
transports: {
[mainnet.id]: http('https://eth-mainnet.g.alchemy.com/v2/...'),
[sepolia.id]: http('https://eth-sepolia.g.alchemy.com/v2/...'),
},
})import {
createConfig,
http
} from '@wagmi/core'
import { mainnet, sepolia } from '@wagmi/core/chains'
export const config = createConfig({
chains: [mainnet, sepolia],
connectors: [injected()],
transports: {
[mainnet.id]: http('https://eth-mainnet.g.alchemy.com/v2/...'),
[sepolia.id]: http('https://eth-sepolia.g.alchemy.com/v2/...'),
},
})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.
Batch JSON-RPC
The http Transport supports Batch JSON-RPC. This means that multiple JSON-RPC requests can be sent in a single HTTP request.
The Transport will batch up Actions over a given period and execute them in a single Batch JSON-RPC HTTP request. By default, this period is a zero delay meaning that the batch request will be executed at the end of the current JavaScript message queue. Consumers can specify a custom time period wait (in ms).
You can enable Batch JSON-RPC by setting the batch flag to true:
const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
batch: true
})const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
batch: true
})Parameters
url
string
URL of the JSON-RPC API. Defaults to chain.rpcUrls.default.http[0].
const transport = http('https://eth-mainnet.g.alchemy.com/v2/...')const transport = http('https://eth-mainnet.g.alchemy.com/v2/...')batch
boolean | BatchOptions
Toggle to enable Batch JSON-RPC. Defaults to false
const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
batch: true
})const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
batch: true
})batch.batchSize
number
The maximum number of JSON-RPC requests to send in a batch. Defaults to 1_000.
const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
batch: {
batchSize: 2_000
}
})const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
batch: {
batchSize: 2_000
}
})batch.wait
number
The maximum number of milliseconds to wait before sending a batch. Defaults to 0 (zero delay).
const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
batch: {
wait: 16
}
})const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
batch: {
wait: 16
}
})fetchOptions
Fetch options to pass to the internal fetch function. Useful for passing auth headers or cache options.
const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
fetchOptions: {
headers: {
'Authorization': 'Bearer ...'
}
}
})const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
fetchOptions: {
headers: {
'Authorization': 'Bearer ...'
}
}
})key
string
A key for the Transport. Defaults to "http".
const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
key: 'alchemy',
})const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
key: 'alchemy',
})name
string
A name for the Transport. Defaults to "HTTP JSON-RPC".
const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
name: 'Alchemy HTTP Provider',
})const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
name: 'Alchemy HTTP Provider',
})retryCount
number
The max number of times to retry when a request fails. Defaults to 3.
const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
retryCount: 5,
})const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
retryCount: 5,
})retryDelay
number
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.
const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
retryDelay: 100,
})const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
retryDelay: 100,
})timeout
number
The timeout for requests. Defaults to 10_000.
const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
timeout: 60_000,
})const transport = http('https://eth-mainnet.g.alchemy.com/v2/...', {
timeout: 60_000,
})