WebSocketProvider
A JSON-RPC provider which is backed by a WebSocket.
WebSockets are often preferred because they retain a live connection to a server, which permits more instant access to events.
However, this incurs higher server infrastructure costs, so additional resources may be required to host your own WebSocket nodes and many third-party services charge additional fees for WebSocket endpoints.
Extends
Constructors
new WebSocketProvider()
new WebSocketProvider(
url,
network?,
options?): WebSocketProvider
Create a new WebSocketProvider.
Parameters
| Parameter | Type | Description |
|---|---|---|
url | string | string[] | WebSocketLike | WebSocketCreator | The URL(s) or WebSocket object or creator. |
network? | Networkish | The network to connect to. |
options? | JsonRpcApiProviderOptions | The options for the JSON-RPC API provider. |
Returns
Overrides
Source
providers/provider-websocket.ts:77
Properties
| Property | Type | Default value | Description |
|---|---|---|---|
readyMap | Map<Shard, boolean> | ... | A map to track the readiness of each shard. |
Accessors
connect
get connect(): FetchRequest[]
Get the list of connected FetchRequests.
Returns
The list of connected FetchRequests.
Source
providers/abstract-provider.ts:796
destroyed
get destroyed(): boolean
If this provider has been destroyed using the destroy method.
Once destroyed, all resources are reclaimed, internal event loops and timers are cleaned up and no further requests may be sent to the provider.
Returns
boolean
Source
providers/abstract-provider.ts:2037
paused
get paused(): boolean
Whether the provider is currently paused.
A paused provider will not emit any events, and generally should not make any requests to the network, but that is up to sub-classes to manage.
Setting paused = true is identical to calling .pause(false), which will buffer any events that occur while
paused until the provider is unpaused.
Returns
boolean
Whether the provider is paused.
Source
providers/abstract-provider.ts:2069
pollingInterval
get pollingInterval(): number
Get the polling interval.
Returns
number
The polling interval.
Source
providers/abstract-provider.ts:915
provider
get provider(): this
Returns this, to allow an AbstractProvider to implement the Contract Runner
interface.
Returns
this
The provider instance.
Source
providers/abstract-provider.ts:925
ready
get ready(): boolean
Returns true only if the JsonRpcApiProvider._start | _start has been called.
Returns
boolean
True if the provider is ready.
Source
providers/provider-jsonrpc.ts:1083
websocket
get websocket(): WebSocketLike[]
Get the array of WebSocketLike objects.
Throws
If the websocket is closed.
Returns
The array of WebSocketLike objects.
Source
providers/provider-websocket.ts:63
Methods
_clearTimeout()
_clearTimeout(timerId): void
Clear a timer created using the AbstractProvider._setTimeout | _setTimeout method.
Parameters
| Parameter | Type | Description |
|---|---|---|
timerId | number | The ID of the timer to clear. |
Returns
void
Inherited from
Source
providers/abstract-provider.ts:1752
destroy()
destroy(): Promise<void>
Destroy the WebSocket connections and clean up resources.
Returns
Promise<void>
A promise that resolves when the WebSocket connections are closed.
Overrides
Source
providers/provider-websocket.ts:254
getLatestQiRate()
getLatestQiRate(zone, amt?): Promise<bigint>
Get the latest Qi rate for a zone.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
zone | Zone | undefined | The zone to get the rate for. |
amt? | number | 1 | The amount to get the rate for. Default is 1 |
Returns
Promise<bigint>
A promise that resolves to the latest Qi rate.
Inherited from
SocketProvider.getLatestQiRate
Source
providers/abstract-provider.ts:883
getLatestQuaiRate()
getLatestQuaiRate(zone, amt?): Promise<bigint>
Get the latest Quai rate for a zone.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
zone | Zone | undefined | The zone to get the rate for. |
amt? | number | 1 | The amount to get the rate for. Default is 1 |
Returns
Promise<bigint>
A promise that resolves to the latest Quai rate.
Inherited from
SocketProvider.getLatestQuaiRate
Source
providers/abstract-provider.ts:838
getProtocolExpansionNumber()
getProtocolExpansionNumber(): Promise<number>
Get the protocol expansion number.
Returns
Promise<number>
A promise that resolves to the protocol expansion number.
Inherited from
SocketProvider.getProtocolExpansionNumber
Source
providers/abstract-provider.ts:870
getQiRateAtBlock()
getQiRateAtBlock(
zone,
blockTag,
amt?): Promise<bigint>
Get the Qi rate at a specific block.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
zone | Zone | undefined | The zone to get the rate for. |
blockTag | BlockTag | undefined | The block tag to get the rate at. |
amt? | number | 1 | The amount to get the rate for. Default is 1 |
Returns
Promise<bigint>
A promise that resolves to the Qi rate at the specified block.
Inherited from
SocketProvider.getQiRateAtBlock
Source
providers/abstract-provider.ts:896
getQuaiRateAtBlock()
getQuaiRateAtBlock(
zone,
blockTag,
amt?): Promise<bigint>
Get the Quai rate at a specific block.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
zone | Zone | undefined | The zone to get the rate for. |
blockTag | BlockTag | undefined | The block tag to get the rate at. |
amt? | number | 1 | The amount to get the rate for. Default is 1 |
Returns
Promise<bigint>
A promise that resolves to the Quai rate at the specified block.
Inherited from
SocketProvider.getQuaiRateAtBlock
Source
providers/abstract-provider.ts:851
getSigner()
getSigner(address?): Promise<JsonRpcSigner>
Returns a JsonRpcSigner for the given address.
Parameters
| Parameter | Type | Description |
|---|---|---|
address? | string | number | The address or index of the account. |
Returns
Promise<JsonRpcSigner>
A promise that resolves to the JsonRpcSigner.
Inherited from
Throws
If the account is invalid.
Source
providers/provider-jsonrpc.ts:1475
listAccounts()
listAccounts(): Promise<JsonRpcSigner[]>
Returns a list of JsonRpcSigners for all accounts.
Returns
Promise<JsonRpcSigner[]>
A promise that resolves to an array of JsonRpcSigners.
Inherited from
Source
providers/provider-jsonrpc.ts:1512
pause()
pause(dropWhilePaused?): void
Pause the provider. If dropWhilePaused, any events that occur while paused are dropped, otherwise all events
will be emitted once the provider is unpaused.
Parameters
| Parameter | Type | Description |
|---|---|---|
dropWhilePaused? | boolean | Whether to drop events while paused. |
Returns
void
Inherited from
Source
providers/abstract-provider.ts:2090
resume()
resume(): void
Resume the provider.
Returns
void
Inherited from
Source
providers/abstract-provider.ts:2119
send()
send(
method,
params,
shard?,
now?): Promise<any>
Requests the method with params via the JSON-RPC protocol over the underlying channel. This can be used to
call methods on the backend that do not have a high-level API within the Provider API.
This method queues requests according to the batch constraints in the options, assigns the request a unique ID.
Do NOT override this method in sub-classes; instead override JsonRpcApiProvider._send | _send or force the options values in the call to the constructor to modify this method’s behavior.
Parameters
| Parameter | Type | Description |
|---|---|---|
method | string | The method to call. |
params | any[] | Record<string, any> | The parameters to pass to the method. |
shard? | Shard | The shard to send the request to. |
now? | boolean | If true, the request will be sent immediately. |
Returns
Promise<any>
A promise that resolves to the result of the method call.
Inherited from
Source
providers/provider-jsonrpc.ts:1433
shardFromHash()
shardFromHash(hash): Shard
Get the shard from a hash.
Parameters
| Parameter | Type | Description |
|---|---|---|
hash | string | The hash to get the shard from. |
Returns
The shard.
Inherited from
Source
providers/abstract-provider.ts:817
waitShardReady()
waitShardReady(shard): Promise<void>
Wait until the shard is ready. Max wait time is ~8 seconds.
Parameters
| Parameter | Type | Description |
|---|---|---|
shard | Shard | The shard identifier. |
Returns
Promise<void>
A promise that resolves when the shard is ready.
Throws
If the shard is not ready within the timeout period.
Source
providers/provider-websocket.ts:131
zoneFromAddress()
zoneFromAddress(_address): Promise<Zone>
Get the zone from an address.
Parameters
| Parameter | Type | Description |
|---|---|---|
_address | AddressLike | The address to get the zone from. |
Returns
Promise<Zone>
A promise that resolves to the zone.
Inherited from
SocketProvider.zoneFromAddress
Source
providers/abstract-provider.ts:806
zoneFromHash()
zoneFromHash(hash): Zone
Get the zone from a hash.
Parameters
| Parameter | Type | Description |
|---|---|---|
hash | string | The hash to get the zone from. |
Returns
The zone.
Inherited from
Source
Was this page helpful?