Class FailoverRpcProvider

Client class to interact with the NEAR RPC API.

See

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

Implements

Provider

Constructors

constructor

new FailoverRpcProvider(providers: Provider[]): FailoverRpcProvider
Parameters
- providers: Provider[]
  list of providers
Returns FailoverRpcProvider
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:17

Methods

accessKeyChanges

accessKeyChanges(
accountIdArray: string[],
blockQuery: BlockReference,
): 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>
Implementation of Provider.accessKeyChanges
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:137

accountChanges

accountChanges(
accountIdArray: string[],
blockQuery: BlockReference,
): 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>
Implementation of Provider.accountChanges
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:151

block

block(blockQuery: BlockId | BlockReference): 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
Implementation of Provider.block
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:90

blockChanges

blockChanges(blockQuery: BlockReference): 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
Implementation of Provider.blockChanges
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:96

callFunction

callFunction(
    accountId: string,
    method: string,
    args: Record<string, unknown>,
    blockQuery?: BlockReference,
): Promise<string | number | boolean | object>
Parameters
- accountId: string
- method: string
- args: Record<string, unknown>
- OptionalblockQuery: BlockReference
Returns Promise<string | number | boolean | object>
Implementation of Provider.callFunction
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:34

callFunctionRaw

callFunctionRaw(
    accountId: string,
    method: string,
    args: Record<string, unknown>,
    blockQuery?: BlockReference,
): Promise<CallContractViewFunctionResultRaw>
Parameters
- accountId: string
- method: string
- args: Record<string, unknown>
- OptionalblockQuery: BlockReference
Returns Promise<CallContractViewFunctionResultRaw>
Implementation of Provider.callFunctionRaw
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:35

chunk

chunk(chunkId: 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
Implementation of Provider.chunk
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:103

contractCodeChanges

contractCodeChanges(
accountIdArray: string[],
blockQuery: BlockReference,
): 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>
Implementation of Provider.contractCodeChanges
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:167

contractStateChanges

contractStateChanges(
    accountIdArray: string[],
    blockQuery: BlockReference,
    keyPrefix?: string,
): 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
- OptionalkeyPrefix: string
Returns Promise<ChangeResult>
Implementation of Provider.contractStateChanges
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:159

experimental_protocolConfig

experimental_protocolConfig(
blockReference: BlockReference | { sync_checkpoint: "genesis" },
): 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>
Implementation of Provider.experimental_protocolConfig
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:116

gasPrice

gasPrice(blockId: 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
Implementation of Provider.gasPrice
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:174

getCurrentEpochSeatPrice

getCurrentEpochSeatPrice(): Promise<bigint>
Returns Promise<bigint>
Implementation of Provider.getCurrentEpochSeatPrice
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:27

getNetworkId

getNetworkId(): Promise<string>
Returns Promise<string>
Implementation of Provider.getNetworkId
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:26

getNextEpochSeatPrice

getNextEpochSeatPrice(): Promise<bigint>
Returns Promise<bigint>
Implementation of Provider.getNextEpochSeatPrice
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:28

lightClientProof

lightClientProof(request: LightClientProofRequest): 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
Implementation of Provider.lightClientProof
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:123

nextLightClientBlock

nextLightClientBlock(
request: NextLightClientBlockRequest,
): 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
Implementation of Provider.nextLightClientBlock
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:131

query

query<T extends QueryResponseKind>(params: RpcQueryRequest): 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
Implementation of Provider.query
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:81
query<T extends QueryResponseKind>(path: string, data: string): Promise<T>
Query the RPC by passing an RpcQueryRequest
Type Parameters
- T extends QueryResponseKind
  the shape of the returned query response
Parameters
- path: string
- data: string
Returns Promise<T>
See
https://docs.near.org/api/rpc/contracts
Implementation of Provider.query
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:82

sendTransaction

sendTransaction(
signedTransaction: 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
Implementation of Provider.sendTransaction
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:51

sendTransactionAsync

sendTransactionAsync(
signedTransaction: 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>
Implementation of Provider.sendTransactionAsync
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:58

sendTransactionUntil

sendTransactionUntil(
signedTransaction: SignedTransaction,
waitUntil: TxExecutionStatus,
): Promise<FinalExecutionOutcome>
Parameters
- signedTransaction: SignedTransaction
- waitUntil: TxExecutionStatus
Returns Promise<FinalExecutionOutcome>
Implementation of Provider.sendTransactionUntil
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:44

singleAccessKeyChanges

singleAccessKeyChanges(
accessKeyArray: AccessKeyWithPublicKey[],
blockQuery: BlockReference,
): 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>
Implementation of Provider.singleAccessKeyChanges
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:144

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
Implementation of Provider.status
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:25

txStatus

txStatus(
    txHash: string | Uint8Array,
    accountId: string,
    waitUntil: TxExecutionStatus,
): 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
Implementation of Provider.txStatus
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:66

txStatusReceipts

txStatusReceipts(
    txHash: string | Uint8Array,
    accountId: string,
    waitUntil: TxExecutionStatus,
): 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>
Implementation of Provider.txStatusReceipts
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:74

validators

validators(blockId: 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
Implementation of Provider.validators
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:110

viewAccessKey

viewAccessKey(
    accountId: string,
    publicKey: PublicKey,
    finalityQuery?: FinalityReference,
): Promise<AccessKeyView>
Parameters
- accountId: string
- publicKey: PublicKey
- OptionalfinalityQuery: FinalityReference
Returns Promise<AccessKeyView>
Implementation of Provider.viewAccessKey
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:29

viewAccessKeyList

viewAccessKeyList(
accountId: string,
finalityQuery?: FinalityReference,
): Promise<AccessKeyList>
Parameters
- accountId: string
- OptionalfinalityQuery: FinalityReference
Returns Promise<AccessKeyList>
Implementation of Provider.viewAccessKeyList
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:30

viewAccount

viewAccount(
accountId: string,
blockQuery?: BlockReference,
): Promise<AccountView>
Parameters
- accountId: string
- OptionalblockQuery: BlockReference
Returns Promise<AccountView>
Implementation of Provider.viewAccount
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:31

viewBlock

viewBlock(blockQuery: BlockReference): Promise<BlockResult>
Parameters
- blockQuery: BlockReference
Returns Promise<BlockResult>
Implementation of Provider.viewBlock
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:36

viewChunk

viewChunk(chunkId: ChunkId): Promise<ChunkResult>
Parameters
- chunkId: ChunkId
Returns Promise<ChunkResult>
Implementation of Provider.viewChunk
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:37

viewContractCode

viewContractCode(
accountId: string,
blockQuery?: BlockReference,
): Promise<ContractCodeView>
Parameters
- accountId: string
- OptionalblockQuery: BlockReference
Returns Promise<ContractCodeView>
Implementation of Provider.viewContractCode
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:32

viewContractState

viewContractState(
    accountId: string,
    prefix?: string,
    blockQuery?: BlockReference,
): Promise<ContractStateView>
Parameters
- accountId: string
- Optionalprefix: string
- OptionalblockQuery: BlockReference
Returns Promise<ContractStateView>
Implementation of Provider.viewContractState
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:33

viewGasPrice

viewGasPrice(blockId?: BlockId): Promise<GasPrice>
Parameters
- OptionalblockId: BlockId
Returns Promise<GasPrice>
Implementation of Provider.viewGasPrice
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:38

viewNodeStatus

viewNodeStatus(): Promise<NodeStatusResult>
Returns Promise<NodeStatusResult>
Implementation of Provider.viewNodeStatus
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:39

viewTransactionReceipt

viewTransactionReceipt(
receiptId: string,
): Promise<ExecutionOutcomeReceiptDetail>
Parameters
- receiptId: string
Returns Promise<ExecutionOutcomeReceiptDetail>
Implementation of Provider.viewTransactionReceipt
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:43

viewTransactionStatus

viewTransactionStatus(
    txHash: string | Uint8Array,
    accountId: string,
    waitUntil: TxExecutionStatus,
): Promise<FinalExecutionOutcome>
Parameters
- txHash: string | Uint8Array
- accountId: string
- waitUntil: TxExecutionStatus
Returns Promise<FinalExecutionOutcome>
Implementation of Provider.viewTransactionStatus
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:41

viewTransactionStatusWithReceipts

viewTransactionStatusWithReceipts(
    txHash: string | Uint8Array,
    accountId: string,
    waitUntil: TxExecutionStatus,
): Promise<
    FinalExecutionOutcome & Required<
        Pick<FinalExecutionOutcome, "receipts">,
    >,
>
Parameters
- txHash: string | Uint8Array
- accountId: string
- waitUntil: TxExecutionStatus
Returns Promise<
    FinalExecutionOutcome & Required<
        Pick<FinalExecutionOutcome, "receipts">,
    >,
>
Implementation of Provider.viewTransactionStatusWithReceipts
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:42

viewValidators

viewValidators(blockId?: BlockId): Promise<EpochValidatorInfo>
Parameters
- OptionalblockId: BlockId
Returns Promise<EpochValidatorInfo>
Implementation of Provider.viewValidators
- Defined in packages/providers/lib/esm/failover-rpc-provider.d.ts:40

Class FailoverRpcProvider

See

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FailoverRpcProvider

Methods

accessKeyChanges

Parameters

Returns Promise<ChangeResult>

accountChanges

Parameters

Returns Promise<ChangeResult>

block

Parameters

Returns Promise<BlockResult>

See

blockChanges

Parameters

Returns Promise<BlockChangeResult>

See

callFunction

Parameters

Returns Promise<string | number | boolean | object>

callFunctionRaw

Parameters

Returns Promise<CallContractViewFunctionResultRaw>

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

getCurrentEpochSeatPrice

Returns Promise<bigint>

getNetworkId

Returns Promise<string>

getNextEpochSeatPrice

Returns Promise<bigint>

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>

See

sendTransaction

Parameters

Returns Promise<FinalExecutionOutcome>

See

sendTransactionAsync

Parameters

Returns Promise<FinalExecutionOutcome>

sendTransactionUntil

Parameters

Returns Promise<
FinalExecutionOutcome & Required<
Pick<FinalExecutionOutcome, "receipts">,
>,
>