JsonRpcApiProvider - Quai Network Docs

The JsonRpcApiProvider is an abstract class and MUST be sub-classed.

It provides the base for all JSON-RPC-based Provider interaction.

Sub-classing Notes:

A sub-class MUST override _send
A sub-class MUST call the _start() method once connected

Extends

AbstractProvider<C>

Extended by

Type parameters

Type parameter	Value
`C`	`FetchRequest`

Constructors

new JsonRpcApiProvider()

new JsonRpcApiProvider<C>(network?, options?): JsonRpcApiProvider<C>

Creates a new JsonRpcApiProvider instance.

Parameters

Parameter	Type	Description
`network`?	`Networkish`	The network to connect to.
`options`?	`JsonRpcApiProviderOptions`	The options for the provider.

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

Parameter	Type	Description
`timerId`	`number`	The ID of the timer to clear.

Returns

void

Inherited from

AbstractProvider._clearTimeout

Source

providers/abstract-provider.ts:1861

destroy()

destroy(): void

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

Returns

void

Overrides

AbstractProvider.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

AbstractProvider.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

AbstractProvider.getActiveZones

Source

providers/abstract-provider.ts:940

getLatestQiRate()

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

Get the latest Qi rate for a zone.

Parameters

Parameter	Type	Description
`zone`	`Zone`	The zone to get the rate for.
`amt`?	`bigint`	The amount to get the rate for. Default is `1`

Returns

Promise<bigint>

A promise that resolves to the latest Qi rate.

Inherited from

AbstractProvider.getLatestQiRate

Source

providers/abstract-provider.ts:962

getLatestQuaiRate()

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

Get the latest Quai rate for a zone.

Parameters

Parameter	Type	Description
`zone`	`Zone`	The zone to get the rate for.
`amt`?	`bigint`	The amount in quais to get the rate for. Default is `1`

Returns

Promise<bigint>

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

Inherited from

AbstractProvider.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

AbstractProvider.getProtocolExpansionNumber

Source

providers/abstract-provider.ts:914

getQiRateAtBlock()

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

Get the Qi rate at a specific block.

Parameters

Parameter	Type	Description
`zone`	`Zone`	The zone to get the rate for.
`blockTag`	`BlockTag`	The block tag to get the rate at.
`amt`?	`bigint`	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

AbstractProvider.getQiRateAtBlock

Source

providers/abstract-provider.ts:975

getQuaiRateAtBlock()

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

Get the Quai rate at a specific block.

Parameters

Parameter	Type	Description
`zone`	`Zone`	The zone to get the rate for.
`blockTag`	`BlockTag`	The block tag to get the rate at.
`amt`?	`bigint`	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

AbstractProvider.getQuaiRateAtBlock

Source

providers/abstract-provider.ts:894

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.

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

Type parameter	Value
`U`	`string`[] \| `FetchRequest`

Parameters

Parameter	Type	Description
`urls`	`U`	The URLs to initialize the map with.

Returns

Promise<void>

A promise that resolves when the map is initialized.

Inherited from

AbstractProvider.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.

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

Parameter	Type	Description
`dropWhilePaused`?	`boolean`	Whether to drop events while paused.

Returns

void

Inherited from

AbstractProvider.pause

Source

providers/abstract-provider.ts:2211

resume()

resume(): void

Resume the provider.

Returns

void

Inherited from

AbstractProvider.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

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.

Source

providers/provider-jsonrpc.ts:1447

shardFromHash()

shardFromHash(hash): Shard

Get the shard from a hash.

Parameters

Parameter	Type	Description
`hash`	`string`	The hash to get the shard from.

Returns

Shard

The shard.

Inherited from

AbstractProvider.shardFromHash

Source

providers/abstract-provider.ts:860

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

AbstractProvider.zoneFromAddress

Source

providers/abstract-provider.ts:849

zoneFromHash()

zoneFromHash(hash): Zone

Get the zone from a hash.

Parameters

Parameter	Type	Description
`hash`	`string`	The hash to get the zone from.

Returns

Zone

The zone.

Inherited from

AbstractProvider.zoneFromHash

Source

providers/abstract-provider.ts:870

Was this page helpful?

FeeData JsonRpcProvider

On this page

Extends
Extended by
Type parameters
Constructors
new JsonRpcApiProvider()
Parameters
Returns
Overrides
Source
Accessors
connect
Returns
Source
destroyed
Returns
Source
paused
Returns
Source
pollingInterval
Returns
Source
provider
Returns
Source
ready
Returns
Source
Methods
_clearTimeout()
Parameters
Returns
Inherited from
Source
destroy()
Returns
Overrides
Source
getActiveRegions()
Returns
Inherited from
Source
getActiveZones()
Returns
Inherited from
Source
getLatestQiRate()
Parameters
Returns
Inherited from
Source
getLatestQuaiRate()
Parameters
Returns
Inherited from
Source
getProtocolExpansionNumber()
Returns
Inherited from
Source
getQiRateAtBlock()
Parameters
Returns
Inherited from
Source
getQuaiRateAtBlock()
Parameters
Returns
Inherited from
Source
getSigner()
Parameters
Returns
Throws
Source
initialize()
Type parameters
Parameters
Returns
Inherited from
Source
listAccounts()
Returns
Source
pause()
Parameters
Returns
Inherited from
Source
resume()
Returns
Inherited from
Source
send()
Parameters
Returns
Source
shardFromHash()
Parameters
Returns
Inherited from
Source
zoneFromAddress()
Parameters
Returns
Inherited from
Source
zoneFromHash()
Parameters
Returns
Inherited from
Source

Getting Started

Fundamentals

Reference

​Extends

​Extended by

​Type parameters

​Constructors

​new JsonRpcApiProvider()

​Parameters

​Returns

​Overrides

​Source

​Accessors

​connect

​Returns

​Source

​destroyed

​Returns

​Source

​paused

​Returns

​Source

​pollingInterval

​Returns

​Source

​provider

​Returns

​Source

​ready

​Returns

​Source

​Methods

​_clearTimeout()

​Parameters

​Returns

​Inherited from

​Source

​destroy()

​Returns

​Overrides

​Source

​getActiveRegions()

​Returns

​Inherited from

​Source

​getActiveZones()

​Returns

​Inherited from

​Source

​getLatestQiRate()

​Parameters

​Returns

​Inherited from

​Source

​getLatestQuaiRate()

​Parameters

​Returns

​Inherited from

​Source

​getProtocolExpansionNumber()

​Returns

​Inherited from

​Source

​getQiRateAtBlock()

​Parameters

​Returns

​Inherited from

​Source

​getQuaiRateAtBlock()

​Parameters

​Returns

​Inherited from

​Source

​getSigner()

​Parameters

​Returns

​Throws

​Source

​initialize()

​Type parameters

Extends

Extended by

Type parameters

Constructors

new JsonRpcApiProvider()

Parameters

Returns

Overrides

Source

Accessors

connect

Returns

Source

destroyed

Returns

Source

paused

Returns

Source

pollingInterval

Returns

Source

provider

Returns

Source

ready

Returns

Source

Methods

_clearTimeout()

Parameters

Returns

Inherited from

Source

destroy()

Returns

Overrides

Source

getActiveRegions()

Returns

Inherited from

Source

getActiveZones()

Returns

Inherited from

Source

getLatestQiRate()

Parameters

Returns

Inherited from

Source

getLatestQuaiRate()

Parameters

Returns

Inherited from

Source

getProtocolExpansionNumber()

Returns

Inherited from

Source

getQiRateAtBlock()

Parameters

Returns

Inherited from

Source

getQuaiRateAtBlock()

Parameters

Returns

Inherited from

Source

getSigner()

Parameters

Returns

Throws

Source

initialize()

Type parameters

Parameters

Returns

Inherited from