Class FailoverRpcProvider

Client class to interact with the NEAR RPC API.

See

https://github.com/near/nearcore/tree/master/chain/jsonrpc

Hierarchy

Provider
- FailoverRpcProvider

Constructors

constructor

new FailoverRpcProvider(providers): FailoverRpcProvider
Parameters
- providers: Provider[]
  list of providers
Returns FailoverRpcProvider
Overrides Provider.constructor
- Defined in packages/providers/src/failover-rpc-provider.ts:48

Properties

`Private` currentProviderIndex

currentProviderIndex: number

Accessors

`Private` currentProvider

get currentProvider(): Provider
Returns Provider
- Defined in packages/providers/src/failover-rpc-provider.ts:73

Methods

accessKeyChanges

accessKeyChanges(accountIdArray, blockQuery): Promise<ChangeResult>
Gets access key changes for a given array of accountIds See docs for more info
Parameters
- accountIdArray: string[]
- blockQuery: BlockReference
Returns Promise<ChangeResult>
Overrides Provider.accessKeyChanges
- Defined in packages/providers/src/failover-rpc-provider.ts:282

accountChanges

accountChanges(accountIdArray, blockQuery): Promise<ChangeResult>
Gets account changes for a given array of accountIds pass block_id OR finality as blockQuery, not both See docs for more info
Parameters
- accountIdArray: string[]
- blockQuery: BlockReference
Returns Promise<ChangeResult>
Overrides Provider.accountChanges
- Defined in packages/providers/src/failover-rpc-provider.ts:313

block

block(blockQuery): Promise<BlockResult>
Query for block info from the RPC pass block_id OR finality as blockQuery, not both
Parameters
- blockQuery: BlockId | BlockReference
  BlockReference (passing a BlockId is deprecated)
Returns Promise<BlockResult>
See
https://docs.near.org/api/rpc/block-chunk
Overrides Provider.block
- Defined in packages/providers/src/failover-rpc-provider.ts:206

blockChanges

blockChanges(blockQuery): Promise<BlockChangeResult>
Query changes in block from the RPC pass block_id OR finality as blockQuery, not both
Parameters
- blockQuery: BlockReference
Returns Promise<BlockChangeResult>
See
https://docs.near.org/api/rpc/block-chunk
Overrides Provider.blockChanges
- Defined in packages/providers/src/failover-rpc-provider.ts:215

chunk

chunk(chunkId): Promise<ChunkResult>
Queries for details about a specific chunk appending details of receipts and transactions to the same chunk data provided by a block
Parameters
- chunkId: ChunkId
  Hash of a chunk ID or shard ID
Returns Promise<ChunkResult>
See
https://docs.near.org/api/rpc/block-chunk
Overrides Provider.chunk
- Defined in packages/providers/src/failover-rpc-provider.ts:226

contractCodeChanges

contractCodeChanges(accountIdArray, blockQuery): Promise<ChangeResult>
Gets contract code changes for a given array of accountIds pass block_id OR finality as blockQuery, not both Note: Change is returned in a base64 encoded WASM file See docs for more info
Parameters
- accountIdArray: string[]
- blockQuery: BlockReference
Returns Promise<ChangeResult>
Overrides Provider.contractCodeChanges
- Defined in packages/providers/src/failover-rpc-provider.ts:348

contractStateChanges

contractStateChanges(accountIdArray, blockQuery, keyPrefix?): Promise<ChangeResult>
Gets contract state changes for a given array of accountIds pass block_id OR finality as blockQuery, not both Note: If you pass a keyPrefix it must be base64 encoded See docs for more info
Parameters
- accountIdArray: string[]
- blockQuery: BlockReference
- keyPrefix: string = ''
Returns Promise<ChangeResult>
Overrides Provider.contractStateChanges
- Defined in packages/providers/src/failover-rpc-provider.ts:328

experimental_protocolConfig

experimental_protocolConfig(blockReference): Promise<NearProtocolConfig>
Gets the protocol config at a block from RPC
Parameters
- blockReference: BlockReference | {
  sync_checkpoint: "genesis";
  }
  specifies the block to get the protocol config for
Returns Promise<NearProtocolConfig>
Overrides Provider.experimental_protocolConfig
- Defined in packages/providers/src/failover-rpc-provider.ts:245

gasPrice

gasPrice(blockId): Promise<GasPrice>
Returns gas price for a specific block_height or block_hash.
Parameters
- blockId: BlockId
  Block hash or height, or null for latest.
Returns Promise<GasPrice>
See
https://docs.near.org/api/rpc/gas
Overrides Provider.gasPrice
- Defined in packages/providers/src/failover-rpc-provider.ts:362

lightClientProof

lightClientProof(request): Promise<LightClientProof>
Gets a light client execution proof for verifying execution outcomes
Parameters
- request: LightClientProofRequest
Returns Promise<LightClientProof>
See
https://github.com/nearprotocol/NEPs/blob/master/specs/ChainSpec/LightClient.md#light-client-proof
Overrides Provider.lightClientProof
- Defined in packages/providers/src/failover-rpc-provider.ts:256

nextLightClientBlock

nextLightClientBlock(request): Promise<NextLightClientBlockResponse>
Returns the next light client block as far in the future as possible from the last known hash to still be able to validate from that hash. This will either return the last block of the next epoch, or the last final known block.
Parameters
- request: NextLightClientBlockRequest
Returns Promise<NextLightClientBlockResponse>
See
https://github.com/near/NEPs/blob/master/specs/ChainSpec/LightClient.md#light-client-block
Overrides Provider.nextLightClientBlock
- Defined in packages/providers/src/failover-rpc-provider.ts:270

query

query<T>(params): Promise<T>
Query the RPC by passing an RpcQueryRequest
Type Parameters
- T extends QueryResponseKind
  the shape of the returned query response
Parameters
- params: RpcQueryRequest
Returns Promise<T>
See
https://docs.near.org/api/rpc/contracts
Overrides Provider.query
- Defined in packages/providers/src/failover-rpc-provider.ts:179
query<T>(path, data): Promise<T>
Type Parameters
- T extends QueryResponseKind
Parameters
- path: string
- data: string
Returns Promise<T>
Overrides Provider.query
- Defined in packages/providers/src/failover-rpc-provider.ts:182

sendTransaction

sendTransaction(signedTransaction): Promise<FinalExecutionOutcome>
Sends a signed transaction to the RPC and waits until transaction is fully complete
Parameters
- signedTransaction: SignedTransaction
  The signed transaction being sent
Returns Promise<FinalExecutionOutcome>
See
https://docs.near.org/docs/develop/front-end/rpc#send-transaction-await
Overrides Provider.sendTransaction
- Defined in packages/providers/src/failover-rpc-provider.ts:121

sendTransactionAsync

sendTransactionAsync(signedTransaction): Promise<FinalExecutionOutcome>
Sends a signed transaction to the RPC and immediately returns transaction hash See docs for more info
Parameters
- signedTransaction: SignedTransaction
  The signed transaction being sent
Returns Promise<FinalExecutionOutcome>
Overrides Provider.sendTransactionAsync
- Defined in packages/providers/src/failover-rpc-provider.ts:134

sendTransactionUntil

sendTransactionUntil(signedTransaction, waitUntil): Promise<FinalExecutionOutcome>
Parameters
- signedTransaction: SignedTransaction
- waitUntil: TxExecutionStatus
Returns Promise<FinalExecutionOutcome>
Overrides Provider.sendTransactionUntil
- Defined in packages/providers/src/failover-rpc-provider.ts:111

singleAccessKeyChanges

singleAccessKeyChanges(accessKeyArray, blockQuery): Promise<ChangeResult>
Gets single access key changes for a given array of access keys pass block_id OR finality as blockQuery, not both See docs for more info
Parameters
- accessKeyArray: AccessKeyWithPublicKey[]
- blockQuery: BlockReference
Returns Promise<ChangeResult>
Overrides Provider.singleAccessKeyChanges
- Defined in packages/providers/src/failover-rpc-provider.ts:296

status

status(): Promise<NodeStatusResult>
Gets the RPC's status

Returns Promise<NodeStatusResult>
See
https://docs.near.org/docs/develop/front-end/rpc#general-validator-status
Overrides Provider.status
- Defined in packages/providers/src/failover-rpc-provider.ts:107

`Private` switchToNextProvider

switchToNextProvider(): void
Returns void
- Defined in packages/providers/src/failover-rpc-provider.ts:59

txStatus

txStatus(txHash, accountId, waitUntil): Promise<FinalExecutionOutcome>
Gets a transaction's status from the RPC
Parameters
- txHash: string | Uint8Array
  A transaction hash as either a Uint8Array or a base58 encoded string
- accountId: string
  The NEAR account that signed the transaction
- waitUntil: TxExecutionStatus
Returns Promise<FinalExecutionOutcome>
See
https://docs.near.org/docs/develop/front-end/rpc#transaction-status
Overrides Provider.txStatus
- Defined in packages/providers/src/failover-rpc-provider.ts:148

txStatusReceipts

txStatusReceipts(txHash, accountId, waitUntil): Promise<FinalExecutionOutcome>
Gets a transaction's status from the RPC with receipts See docs for more info
Parameters
- txHash: string | Uint8Array
  The hash of the transaction
- accountId: string
  The NEAR account that signed the transaction
- waitUntil: TxExecutionStatus
Returns Promise<FinalExecutionOutcome>
Overrides Provider.txStatusReceipts
- Defined in packages/providers/src/failover-rpc-provider.ts:164

validators

validators(blockId): Promise<EpochValidatorInfo>
Query validators of the epoch defined by the given block id.
Parameters
- blockId: BlockId
  Block hash or height, or null for latest.
Returns Promise<EpochValidatorInfo>
See
https://docs.near.org/api/rpc/network#validation-status
Overrides Provider.validators
- Defined in packages/providers/src/failover-rpc-provider.ts:236

`Private` withBackoff

withBackoff(getResult): Promise<any>
Parameters
- getResult: ((provider) => Promise<any>)
  - - (provider): Promise<any>
    - Parameters
      provider: Provider
      Returns Promise<any>
Returns Promise<any>
- Defined in packages/providers/src/failover-rpc-provider.ts:84

Class FailoverRpcProvider

See

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FailoverRpcProvider

Properties

Private currentProviderIndex

Accessors

Private currentProvider

Returns Provider

Methods

accessKeyChanges

Parameters

Returns Promise<ChangeResult>

accountChanges

Parameters

Returns Promise<ChangeResult>

block

Parameters

Returns Promise<BlockResult>

See

blockChanges

Parameters

Returns Promise<BlockChangeResult>

See

chunk

Parameters

Returns Promise<ChunkResult>

See

contractCodeChanges

Parameters

Returns Promise<ChangeResult>

contractStateChanges

Parameters

Returns Promise<ChangeResult>

experimental_protocolConfig

Parameters

Returns Promise<NearProtocolConfig>

gasPrice

Parameters

Returns Promise<GasPrice>

See

lightClientProof

Parameters

Returns Promise<LightClientProof>

See

nextLightClientBlock

Parameters

Returns Promise<NextLightClientBlockResponse>

See

query

Type Parameters

Parameters

Returns Promise<T>

See

Type Parameters

Parameters

Returns Promise<T>

sendTransaction

Parameters

Returns Promise<FinalExecutionOutcome>

See

sendTransactionAsync

Parameters

Returns Promise<FinalExecutionOutcome>

sendTransactionUntil

Parameters

Returns Promise<FinalExecutionOutcome>

singleAccessKeyChanges

Parameters

Returns Promise<ChangeResult>

status

Returns Promise<NodeStatusResult>

`Private` currentProviderIndex

`Private` currentProvider

`Private` switchToNextProvider

`Private` withBackoff