Class JsonRpcProvider

Client class to interact with the NEAR RPC API.

See

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

Hierarchy

Provider
- JsonRpcProvider

Constructors

constructor

new JsonRpcProvider(connectionInfo, options?): JsonRpcProvider
Parameters
- connectionInfo: ConnectionInfo
  Connection info
- Optional options: Partial<RequestOptions>
Returns JsonRpcProvider
Overrides Provider.constructor
- Defined in json-rpc-provider.ts:89

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 json-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 json-rpc-provider.ts:316

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 json-rpc-provider.ts:211

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 json-rpc-provider.ts:222

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 json-rpc-provider.ts:234

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 json-rpc-provider.ts:353

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 json-rpc-provider.ts:334

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 json-rpc-provider.ts:253

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 json-rpc-provider.ts:370

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 json-rpc-provider.ts:262

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 json-rpc-provider.ts:273

query

query<T>(...args): Promise<T>
Query the RPC by passing an RpcQueryRequest
Type Parameters
- T extends QueryResponseKind
  the shape of the returned query response
Parameters
- Rest ...args: any[]
Returns Promise<T>
See
https://docs.near.org/api/rpc/contracts
Overrides Provider.query
- Defined in json-rpc-provider.ts:186

sendJsonRpc

sendJsonRpc<T>(method, params): Promise<T>
Directly call the RPC specifying the method and params
Type Parameters
- T
Parameters
- method: string
  RPC method
- params: object
  Parameters to the method
Returns Promise<T>
- Defined in json-rpc-provider.ts:380

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 json-rpc-provider.ts:125

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 json-rpc-provider.ts:135

sendTransactionUntil

sendTransactionUntil(signedTransaction, waitUntil): Promise<FinalExecutionOutcome>
Sends a signed transaction to the RPC
Parameters
- signedTransaction: SignedTransaction
  The signed transaction being sent
- waitUntil: TxExecutionStatus
Returns Promise<FinalExecutionOutcome>
Overrides Provider.sendTransactionUntil
- Defined in json-rpc-provider.ts:114

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 json-rpc-provider.ts:299

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 json-rpc-provider.ts:104

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 = 'FINAL'
Returns Promise<FinalExecutionOutcome>
See
https://docs.near.org/docs/develop/front-end/rpc#transaction-status
Overrides Provider.txStatus
- Defined in json-rpc-provider.ts:147

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 = 'FINAL'
Returns Promise<FinalExecutionOutcome>
Overrides Provider.txStatusReceipts
- Defined in json-rpc-provider.ts:171

`Private` txStatusString

txStatusString(txHash, accountId, waitUntil): Promise<FinalExecutionOutcome>
Parameters
- txHash: string
- accountId: string
- waitUntil: string
Returns Promise<FinalExecutionOutcome>
- Defined in json-rpc-provider.ts:159

`Private` txStatusUint8Array

txStatusUint8Array(txHash, accountId, waitUntil): Promise<FinalExecutionOutcome>
Parameters
- txHash: Uint8Array
- accountId: string
- waitUntil: TxExecutionStatus
Returns Promise<FinalExecutionOutcome>
- Defined in json-rpc-provider.ts:155

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 json-rpc-provider.ts:244

Class JsonRpcProvider

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

connectionInfo: ConnectionInfo

Optional options: Partial<RequestOptions>

Returns JsonRpcProvider

Methods

accessKeyChanges

Parameters

accountIdArray: string[]

blockQuery: BlockReference

Returns Promise<ChangeResult>

accountChanges

Parameters

accountIdArray: string[]

blockQuery: BlockReference

Returns Promise<ChangeResult>

block

Parameters

blockQuery: BlockId | BlockReference

Returns Promise<BlockResult>

See

blockChanges

Parameters

blockQuery: BlockReference

Returns Promise<BlockChangeResult>

See

chunk

Parameters

chunkId: ChunkId

Returns Promise<ChunkResult>

See

contractCodeChanges

Parameters

accountIdArray: string[]

blockQuery: BlockReference

Returns Promise<ChangeResult>

contractStateChanges

Parameters

accountIdArray: string[]

blockQuery: BlockReference

keyPrefix: string = ''

Returns Promise<ChangeResult>

experimental_protocolConfig

Parameters

blockReference: BlockReference | { sync_checkpoint: "genesis"; }

Returns Promise<NearProtocolConfig>

gasPrice

Parameters

blockId: BlockId

Returns Promise<GasPrice>

See

lightClientProof

Parameters

request: LightClientProofRequest

Returns Promise<LightClientProof>

See

nextLightClientBlock

Parameters

request: NextLightClientBlockRequest

Returns Promise<NextLightClientBlockResponse>

See

query

Type Parameters

T extends QueryResponseKind

Parameters

Rest ...args: any[]

Returns Promise<T>

See

sendJsonRpc

Type Parameters

T

Parameters

method: string

`Optional` options: Partial<RequestOptions>

blockReference: BlockReference | {
sync_checkpoint: "genesis";
}

`Rest` ...args: any[]

`Private` txStatusString

`Private` txStatusUint8Array