SocketProvider

A SocketProvider is backed by a long-lived connection over a socket, which can subscribe and receive real-time messages over its communication channel.

​

Extends

• JsonRpcApiProvider<WebSocketLike>

​

Extended by

• WebSocketProvider

​

Constructors

​

new SocketProvider()

new SocketProvider(network?, _options?): SocketProvider

Creates a new SocketProvider connected to network.

If unspecified, the network will be discovered.

​

Parameters

​

Returns

SocketProvider

​

Overrides

JsonRpcApiProvider.constructor

​

Source

providers/provider-socket.ts:320

​

Accessors

​

connect

get connect(): FetchRequest[]

Get the list of connected FetchRequests.

​

Returns

FetchRequest[]

The list of connected FetchRequests.

​

Source

providers/abstract-provider.ts:839

​

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:2158

​

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:2190

​

pollingInterval

get pollingInterval(): number

Get the polling interval.

​

Returns

number

The polling interval.

​

Source

providers/abstract-provider.ts:996

​

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:1006

​

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:1079

​

Methods

​

_clearTimeout()

_clearTimeout(timerId): void

Clear a timer created using the AbstractProvider._setTimeout | _setTimeout method.

​

Parameters

​

Returns

void

​

Inherited from

JsonRpcApiProvider._clearTimeout

​

Source

providers/abstract-provider.ts:1861

​

destroy()

destroy(): void

Destroys the provider, stopping all processing and canceling all pending requests.

​

Returns

void

​

Inherited from

JsonRpcApiProvider.destroy

​

Source

providers/provider-jsonrpc.ts:1534

​

getActiveRegions()

getActiveRegions(): Promise<Shard[]>

Get the active region shards based on the protocol expansion number.

​

Returns

Promise<Shard[]>

A promise that resolves to the active shards.

​

Inherited from

JsonRpcApiProvider.getActiveRegions

​

Source

providers/abstract-provider.ts:923

​

getActiveZones()

getActiveZones(): Promise<Zone[]>

Get the active zones for a shard based on the protocol expansion number.

​

Returns

Promise<Zone[]>

A promise that resolves to the active zones.

​

Inherited from

JsonRpcApiProvider.getActiveZones

​

Source

providers/abstract-provider.ts:940

​

getLatestQiRate()

getLatestQiRate(zone, amt?): Promise<bigint>

Get the latest Qi rate for a zone.

​

Parameters

​

Returns

Promise<bigint>

A promise that resolves to the latest Qi rate.

​

Inherited from

JsonRpcApiProvider.getLatestQiRate

​

Source

providers/abstract-provider.ts:962

​

getLatestQuaiRate()

getLatestQuaiRate(zone, amt?): Promise<bigint>

Get the latest Quai rate for a zone.

​

Parameters

​

Returns

Promise<bigint>

A promise that resolves to the latest Quai -> Qi rate for the given amount.

​

Inherited from

JsonRpcApiProvider.getLatestQuaiRate

​

Source

providers/abstract-provider.ts:881

​

getProtocolExpansionNumber()

getProtocolExpansionNumber(): Promise<number>

Get the protocol expansion number.

​

Returns

Promise<number>

A promise that resolves to the protocol expansion number.

​

Inherited from

JsonRpcApiProvider.getProtocolExpansionNumber

​

Source

providers/abstract-provider.ts:914

​

getQiRateAtBlock()

getQiRateAtBlock(
   zone, 
   blockTag, 
amt?): Promise<bigint>

Get the Qi rate at a specific block.

​

Parameters

​

Returns

Promise<bigint>

A promise that resolves to the Qi rate at the specified block.

​

Inherited from

JsonRpcApiProvider.getQiRateAtBlock

​

Source

providers/abstract-provider.ts:975

​

getQuaiRateAtBlock()

getQuaiRateAtBlock(
   zone, 
   blockTag, 
amt?): Promise<bigint>

Get the Quai rate at a specific block.

​

Parameters

​

Returns

Promise<bigint>

A promise that resolves to the Quai rate at the specified block.

​

Inherited from

JsonRpcApiProvider.getQuaiRateAtBlock

​

Source

providers/abstract-provider.ts:894

​

getSigner()

getSigner(address?): Promise<JsonRpcSigner>

Returns a JsonRpcSigner for the given address.

​

Parameters

​

Returns

Promise<JsonRpcSigner>

A promise that resolves to the JsonRpcSigner.

​

Inherited from

JsonRpcApiProvider.getSigner

​

Throws

If the account is invalid.

​

Source

providers/provider-jsonrpc.ts:1489

​

initialize()

initialize<U>(urls): Promise<void>

Initialize the URL map with the provided URLs.

​

Type parameters

​

Parameters

​

Returns

Promise<void>

A promise that resolves when the map is initialized.

​

Inherited from

JsonRpcApiProvider.initialize

​

Source

providers/abstract-provider.ts:787

​

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

JsonRpcApiProvider.listAccounts

​

Source

providers/provider-jsonrpc.ts:1526

​

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

​

Returns

void

​

Inherited from

JsonRpcApiProvider.pause

​

Source

providers/abstract-provider.ts:2211

​

resume()

resume(): void

Resume the provider.

​

Returns

void

​

Inherited from

JsonRpcApiProvider.resume

​

Source

providers/abstract-provider.ts:2240

​

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

​

Returns

Promise<any>

A promise that resolves to the result of the method call.

​

Inherited from

JsonRpcApiProvider.send

​

Source

providers/provider-jsonrpc.ts:1447

​

shardFromHash()

shardFromHash(hash): Shard

Get the shard from a hash.

​

Parameters

​

Returns

Shard

The shard.

​

Inherited from

JsonRpcApiProvider.shardFromHash

​

Source

providers/abstract-provider.ts:860

​

zoneFromAddress()

zoneFromAddress(_address): Promise<Zone>

Get the zone from an address.

​

Parameters

​

Returns

Promise<Zone>

A promise that resolves to the zone.

​

Inherited from

JsonRpcApiProvider.zoneFromAddress

​

Source

providers/abstract-provider.ts:849

​

zoneFromHash()

zoneFromHash(hash): Zone

Get the zone from a hash.

​

Parameters

​

Returns

Zone

The zone.

​

Inherited from

JsonRpcApiProvider.zoneFromHash

​

Source

providers/abstract-provider.ts:870