Class JsonRpcProvider

Client class to interact with the NEAR RPC API.

See

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

Constructors

constructor

new JsonRpcProvider(
connectionInfo: ConnectionInfo,
options?: Partial<RequestOptions>,
): JsonRpcProvider
Parameters
- connectionInfo: ConnectionInfo
  Connection info
- Optionaloptions: Partial<RequestOptions>
Returns JsonRpcProvider
- Defined in src/providers/json-rpc-provider.ts:109

Methods

accessKeyChanges

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

accountChanges

accountChanges(
accountIdArray: string[],
blockQuery: BlockReference,
): Promise<RpcStateChangesInBlockResponse>
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<RpcStateChangesInBlockResponse>
Implementation of Provider.accountChanges
- Defined in src/providers/json-rpc-provider.ts:564

blockChanges

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

callFunction

callFunction<T extends SerializedReturnValue>(
    __namedParameters: {
        args: Uint8Array<ArrayBufferLike> | Record<string, unknown>;
        blockQuery?: BlockReference;
        contractId: string;
        method: string;
    },
): Promise<T | undefined>
Type Parameters
- T extends SerializedReturnValue
Parameters
- __namedParameters: {
      args: Uint8Array<ArrayBufferLike> | Record<string, unknown>;
      blockQuery?: BlockReference;
      contractId: string;
      method: string;
  }
Returns Promise<T | undefined>
Implementation of Provider.callFunction
- Defined in src/providers/json-rpc-provider.ts:305

callFunctionRaw

callFunctionRaw(
    __namedParameters: {
        args: Uint8Array<ArrayBufferLike> | Record<string, unknown>;
        blockQuery?: BlockReference;
        contractId: string;
        method: string;
    },
): Promise<CallResult & { block_hash: string; block_height: number }>
Parameters
- __namedParameters: {
      args: Uint8Array<ArrayBufferLike> | Record<string, unknown>;
      blockQuery?: BlockReference;
      contractId: string;
      method: string;
  }
Returns Promise<CallResult & { block_hash: string; block_height: number }>
Implementation of Provider.callFunctionRaw
- Defined in src/providers/json-rpc-provider.ts:324

contractCodeChanges

contractCodeChanges(
accountIdArray: string[],
blockQuery: BlockReference,
): Promise<RpcStateChangesInBlockResponse>
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<RpcStateChangesInBlockResponse>
Implementation of Provider.contractCodeChanges
- Defined in src/providers/json-rpc-provider.ts:606

contractStateChanges

contractStateChanges(
    accountIdArray: string[],
    blockQuery: BlockReference,
    keyPrefix?: string,
): Promise<RpcStateChangesInBlockResponse>
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<RpcStateChangesInBlockResponse>
Implementation of Provider.contractStateChanges
- Defined in src/providers/json-rpc-provider.ts:584

experimental_protocolConfig

experimental_protocolConfig(
blockReference: BlockReference | { sync_checkpoint: "genesis" },
): Promise<RpcProtocolConfigResponse>
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<RpcProtocolConfigResponse>
Implementation of Provider.experimental_protocolConfig
- Defined in src/providers/json-rpc-provider.ts:496

getCurrentEpochSeatPrice

getCurrentEpochSeatPrice(): Promise<bigint>
Returns Promise<bigint>
Implementation of Provider.getCurrentEpochSeatPrice
- Defined in src/providers/json-rpc-provider.ts:130

getNetworkId

getNetworkId(): Promise<string>
Returns Promise<string>
Implementation of Provider.getNetworkId
- Defined in src/providers/json-rpc-provider.ts:120

getNextEpochSeatPrice

getNextEpochSeatPrice(): Promise<bigint>
Returns Promise<bigint>
Implementation of Provider.getNextEpochSeatPrice
- Defined in src/providers/json-rpc-provider.ts:145

lightClientProof

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

nextLightClientBlock

nextLightClientBlock(
request: NextLightClientBlockRequest,
): Promise<RpcLightClientNextBlockResponse>
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<RpcLightClientNextBlockResponse>
See
https://github.com/near/NEPs/blob/master/specs/ChainSpec/LightClient.md#light-client-block
Implementation of Provider.nextLightClientBlock
- Defined in src/providers/json-rpc-provider.ts:518

query

query<R extends Omit<RpcQueryResponse, "block_hash" | "block_height">>(
params: RpcQueryRequest,
): Promise<R & { block_hash: string; block_height: number }>
Query the RPC by passing an RpcQueryRequest
Type Parameters
- R extends Omit<RpcQueryResponse, "block_hash" | "block_height">
Parameters
- params: RpcQueryRequest
Returns Promise<R & { block_hash: string; block_height: number }>
See
https://docs.near.org/api/rpc/contracts
Implementation of Provider.query
- Defined in src/providers/json-rpc-provider.ts:469

sendJsonRpc

sendJsonRpc<
    Method extends keyof Methods,
    Params = Methods[Method]["request"]["params"],
    Result = Extract<Methods[Method]["response"], { result: object }>["result"],
>(
    method: Method,
    params: Params,
): Promise<Result>
Directly call the RPC specifying the method and params
Type Parameters
- Method extends keyof Methods
- Params = Methods[Method]["request"]["params"]
- Result = Extract<Methods[Method]["response"], { result: object }>["result"]
Parameters
- method: Method
  RPC method
- params: Params
  Parameters to the method
Returns Promise<Result>
- Defined in src/providers/json-rpc-provider.ts:626

sendTransaction

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

sendTransactionAsync

sendTransactionAsync(
signedTransaction: SignedTransaction,
): Promise<RpcTransactionResponse>
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<RpcTransactionResponse>
Implementation of Provider.sendTransactionAsync
- Defined in src/providers/json-rpc-provider.ts:460

sendTransactionUntil

sendTransactionUntil(
signedTransaction: SignedTransaction,
waitUntil: TxExecutionStatus,
): Promise<RpcTransactionResponse>
Sends a signed transaction to the RPC
Parameters
- signedTransaction: SignedTransaction
  The signed transaction being sent
- waitUntil: TxExecutionStatus
Returns Promise<RpcTransactionResponse>
Implementation of Provider.sendTransactionUntil
- Defined in src/providers/json-rpc-provider.ts:433

singleAccessKeyChanges

singleAccessKeyChanges(
accessKeyArray: AccessKeyWithPublicKey[],
blockQuery: BlockReference,
): Promise<RpcStateChangesInBlockResponse>
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<RpcStateChangesInBlockResponse>
Implementation of Provider.singleAccessKeyChanges
- Defined in src/providers/json-rpc-provider.ts:545

viewAccessKey

viewAccessKey(
    __namedParameters: {
        accountId: string;
        finalityQuery?: FinalityReference;
        publicKey: string | PublicKey;
    },
): Promise<
    {
        block_hash: string;
        block_height: number;
        nonce: bigint;
        permission: AccessKeyPermissionView;
    },
>
Parameters
- __namedParameters: {
      accountId: string;
      finalityQuery?: FinalityReference;
      publicKey: string | PublicKey;
  }
Returns Promise<
    {
        block_hash: string;
        block_height: number;
        nonce: bigint;
        permission: AccessKeyPermissionView;
    },
>
Implementation of Provider.viewAccessKey
- Defined in src/providers/json-rpc-provider.ts:160

viewAccessKeyList

viewAccessKeyList(
    __namedParameters: {
        accountId: string;
        finalityQuery?: FinalityReference;
    },
): Promise<AccessKeyList & { block_hash: string; block_height: number }>
Parameters
- __namedParameters: { accountId: string; finalityQuery?: FinalityReference }
Returns Promise<AccessKeyList & { block_hash: string; block_height: number }>
Implementation of Provider.viewAccessKeyList
- Defined in src/providers/json-rpc-provider.ts:178

viewAccount

viewAccount(
    __namedParameters: { accountId: string; blockQuery?: BlockReference },
): Promise<
    {
        amount: bigint;
        block_hash: string;
        block_height: number;
        code_hash: string;
        global_contract_account_id?: string
        | null;
        global_contract_hash?: string | null;
        locked: bigint;
        storage_paid_at?: number;
        storage_usage: number;
    },
>
Parameters
- __namedParameters: { accountId: string; blockQuery?: BlockReference }
Returns Promise<
    {
        amount: bigint;
        block_hash: string;
        block_height: number;
        code_hash: string;
        global_contract_account_id?: string
        | null;
        global_contract_hash?: string | null;
        locked: bigint;
        storage_paid_at?: number;
        storage_usage: number;
    },
>
Implementation of Provider.viewAccount
- Defined in src/providers/json-rpc-provider.ts:189

viewBlock

viewBlock(blockQuery: BlockReference): Promise<RpcBlockResponse>
Parameters
- blockQuery: BlockReference
Returns Promise<RpcBlockResponse>
Implementation of Provider.viewBlock
- Defined in src/providers/json-rpc-provider.ts:354

viewChunk

viewChunk(chunkId: ChunkId): Promise<RpcChunkResponse>
Parameters
- chunkId: ChunkId
Returns Promise<RpcChunkResponse>
Implementation of Provider.viewChunk
- Defined in src/providers/json-rpc-provider.ts:360

viewContractCode

viewContractCode(
    __namedParameters: { blockQuery?: BlockReference; contractId: string },
): Promise<
    {
        block_hash: string;
        block_height: number;
        code: Uint8Array<ArrayBuffer>;
        code_base64: string;
        hash: string;
    },
>
Parameters
- __namedParameters: { blockQuery?: BlockReference; contractId: string }
Returns Promise<
    {
        block_hash: string;
        block_height: number;
        code: Uint8Array<ArrayBuffer>;
        code_base64: string;
        hash: string;
    },
>
Implementation of Provider.viewContractCode
- Defined in src/providers/json-rpc-provider.ts:213

viewContractState

viewContractState(
    __namedParameters: {
        blockQuery?: BlockReference;
        contractId: string;
        prefix?: string;
    },
): Promise<ViewStateResult & { block_hash: string; block_height: number }>
Parameters
- __namedParameters: { blockQuery?: BlockReference; contractId: string; prefix?: string }
Returns Promise<ViewStateResult & { block_hash: string; block_height: number }>
Implementation of Provider.viewContractState
- Defined in src/providers/json-rpc-provider.ts:280

viewGasPrice

viewGasPrice(blockId?: BlockId): Promise<RpcGasPriceResponse>
Parameters
- OptionalblockId: BlockId
Returns Promise<RpcGasPriceResponse>
Implementation of Provider.viewGasPrice
- Defined in src/providers/json-rpc-provider.ts:364

viewGlobalContractCode

viewGlobalContractCode(
    __namedParameters: {
        blockQuery?: BlockReference;
        identifier:
            | { codeHash: string
            | Uint8Array<ArrayBufferLike> }
            | { accountId: string };
    },
): Promise<
    {
        block_hash: string;
        block_height: number;
        code: Uint8Array<ArrayBuffer>;
        code_base64: string;
        hash: string;
    },
>
Parameters
- __namedParameters: {
      blockQuery?: BlockReference;
      identifier:
          | { codeHash: string
          | Uint8Array<ArrayBufferLike> }
          | { accountId: string };
  }
Returns Promise<
    {
        block_hash: string;
        block_height: number;
        code: Uint8Array<ArrayBuffer>;
        code_base64: string;
        hash: string;
    },
>
Implementation of Provider.viewGlobalContractCode
- Defined in src/providers/json-rpc-provider.ts:236

viewNodeStatus

viewNodeStatus(): Promise<RpcStatusResponse>
Returns Promise<RpcStatusResponse>
Implementation of Provider.viewNodeStatus
- Defined in src/providers/json-rpc-provider.ts:368

viewTransactionReceipt

viewTransactionReceipt(receiptId: string): Promise<RpcReceiptResponse>
Parameters
- receiptId: string
Returns Promise<RpcReceiptResponse>
Implementation of Provider.viewTransactionReceipt
- Defined in src/providers/json-rpc-provider.ts:421

viewTransactionStatus

viewTransactionStatus(
    __namedParameters: {
        accountId: string;
        txHash: string | Uint8Array<ArrayBufferLike>;
        waitUntil?: TxExecutionStatus;
    },
): Promise<RpcTransactionResponse>
Parameters
- __namedParameters: {
      accountId: string;
      txHash: string | Uint8Array<ArrayBufferLike>;
      waitUntil?: TxExecutionStatus;
  }
Returns Promise<RpcTransactionResponse>
Implementation of Provider.viewTransactionStatus
- Defined in src/providers/json-rpc-provider.ts:393

viewTransactionStatusWithReceipts

viewTransactionStatusWithReceipts(
    __namedParameters: {
        accountId: string;
        txHash: string | Uint8Array<ArrayBufferLike>;
        waitUntil?: TxExecutionStatus;
    },
): Promise<RpcTransactionResponse>
Parameters
- __namedParameters: {
      accountId: string;
      txHash: string | Uint8Array<ArrayBufferLike>;
      waitUntil?: TxExecutionStatus;
  }
Returns Promise<RpcTransactionResponse>
Implementation of Provider.viewTransactionStatusWithReceipts
- Defined in src/providers/json-rpc-provider.ts:407

viewValidators

viewValidators(params?: ViewValidatorsArgs): Promise<RpcValidatorResponse>
Query validators of an epoch.
Parameters
- Optionalparams: ViewValidatorsArgs
  Object specifying either a block or epoch to query.
  
  { blockId }: Block hash or height.
  
  { epochId }: Epoch hash.
  
  null: Current epoch.
Returns Promise<RpcValidatorResponse>
See
https://docs.near.org/api/rpc/network#validation-status
Implementation of Provider.viewValidators
- Defined in src/providers/json-rpc-provider.ts:381

Class JsonRpcProvider

See

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns JsonRpcProvider

Methods

accessKeyChanges

Parameters

Returns Promise<RpcStateChangesInBlockResponse>

accountChanges

Parameters

Returns Promise<RpcStateChangesInBlockResponse>

blockChanges

Parameters

Returns Promise<RpcStateChangesInBlockByTypeResponse>

See

callFunction

Type Parameters

Parameters

Returns Promise<T | undefined>

callFunctionRaw

Parameters

Returns Promise<CallResult & { block_hash: string; block_height: number }>

contractCodeChanges

Parameters

Returns Promise<RpcStateChangesInBlockResponse>

contractStateChanges

Parameters

Returns Promise<RpcStateChangesInBlockResponse>

experimental_protocolConfig

Parameters

Returns Promise<RpcProtocolConfigResponse>

getCurrentEpochSeatPrice

Returns Promise<bigint>

getNetworkId

Returns Promise<string>

getNextEpochSeatPrice

Returns Promise<bigint>

lightClientProof

Parameters

Returns Promise<RpcLightClientExecutionProofResponse>

See

nextLightClientBlock

Parameters

Returns Promise<RpcLightClientNextBlockResponse>

See

query

Type Parameters

Parameters

Returns Promise<R & { block_hash: string; block_height: number }>

See

sendJsonRpc

Type Parameters

Parameters

Returns Promise<Result>

sendTransaction

Parameters

Returns Promise<RpcTransactionResponse>

See

sendTransactionAsync

Parameters

Returns Promise<RpcTransactionResponse>

sendTransactionUntil

Parameters

Returns Promise<RpcTransactionResponse>

singleAccessKeyChanges

Parameters

Returns Promise<RpcStateChangesInBlockResponse>

viewAccessKey

Parameters

Returns Promise< { block_hash: string; block_height: number; nonce: bigint; permission: AccessKeyPermissionView; },>

viewAccessKeyList

Parameters

Returns Promise<AccessKeyList & { block_hash: string; block_height: number }>

viewAccount

Parameters

Returns Promise<
{
block_hash: string;
block_height: number;
nonce: bigint;
permission: AccessKeyPermissionView;
},
>

Returns Promise<
{
amount: bigint;
block_hash: string;
block_height: number;
code_hash: string;
global_contract_account_id?: string
| null;
global_contract_hash?: string | null;
locked: bigint;
storage_paid_at?: number;
storage_usage: number;
},
>

Returns Promise<
{
block_hash: string;
block_height: number;
code: Uint8Array<ArrayBuffer>;
code_base64: string;
hash: string;
},
>

Returns Promise<
{
block_hash: string;
block_height: number;
code: Uint8Array<ArrayBuffer>;
code_base64: string;
hash: string;
},
>