Class RpcClient

Hierarchy

RpcClient

Implements

IClient

Index

Constructors

Properties

Methods

getAccountInfo getAccountInfoByBlockHash getAccountInfoByBlockHeight getAuctionInfoByHash getAuctionInfoByHeight getBalanceByStateRootHash getBlockByHash getBlockByHeight getBlockTransfersByHash getBlockTransfersByHeight getChainspec getDelegatorRewardByBlockHash getDelegatorRewardByBlockHeight getDelegatorRewardByEraID getDeploy getDeployFinalizedApproval getDictionaryItem getDictionaryItemByIdentifier getEntityByBlockHash getEntityByBlockHeight getEraInfoByBlockHash getEraInfoByBlockHeight getEraInfoLatest getEraSummaryByHash getEraSummaryByHeight getEraSummaryLatest getLatestAuctionInfo getLatestBalance getLatestBlock getLatestBlockTransfers getLatestDelegatorReward getLatestEntity getLatestValidatorReward getPeers getStateItem getStateRootHashByHash getStateRootHashByHeight getStateRootHashLatest getStatus getTransactionByDeployHash getTransactionByTransactionHash getTransactionFinalizedApprovalByDeployHash getTransactionFinalizedApprovalByTransactionHash getValidatorChangesInfo getValidatorRewardByBlockHash getValidatorRewardByBlockHeight getValidatorRewardByEraID parseResponse processRequest putDeploy putTransaction queryBalanceByBlockHash queryBalanceByBlockHeight queryBalanceByStateRootHash queryBalanceDetailsByBlockHash queryBalanceDetailsByBlockHeight queryBalanceDetailsByStateRootHash queryGlobalStateByBlockHash queryGlobalStateByBlockHeight queryGlobalStateByStateHash queryLatestBalance queryLatestBalanceDetails queryLatestGlobalState

Constructors

constructor

new RpcClient(handler: IHandler): RpcClient
Parameters
- handler: IHandler
Returns RpcClient
- Defined in src/rpc/rpc_client.ts:71

Properties

`Private` handler

handler: IHandler

Methods

getAccountInfo

getAccountInfo(blockIdentifier: null | ParamBlockIdentifier, accountIdentifier: AccountIdentifier): Promise<StateGetAccountInfo>
Parameters
- blockIdentifier: null | ParamBlockIdentifier
- accountIdentifier: AccountIdentifier
Returns Promise<StateGetAccountInfo>
Implementation of IClient.getAccountInfo
- Defined in src/rpc/rpc_client.ts:456

getAccountInfoByBlockHash

getAccountInfoByBlockHash(blockHash: string, pub: PublicKey): Promise<StateGetAccountInfo>
Parameters
- blockHash: string
- pub: PublicKey
Returns Promise<StateGetAccountInfo>
Implementation of IClient.getAccountInfoByBlockHash
- Defined in src/rpc/rpc_client.ts:414

getAccountInfoByBlockHeight

getAccountInfoByBlockHeight(blockHeight: number, pub: PublicKey): Promise<StateGetAccountInfo>
Parameters
- blockHeight: number
- pub: PublicKey
Returns Promise<StateGetAccountInfo>
Implementation of IClient.getAccountInfoByBlockHeight
- Defined in src/rpc/rpc_client.ts:435

getAuctionInfoByHash

getAuctionInfoByHash(blockHash: string): Promise<StateGetAuctionInfoResult>
Parameters
- blockHash: string
Returns Promise<StateGetAuctionInfoResult>
Implementation of IClient.getAuctionInfoByHash
- Defined in src/rpc/rpc_client.ts:784

getAuctionInfoByHeight

getAuctionInfoByHeight(height: number): Promise<StateGetAuctionInfoResult>
Parameters
- height: number
Returns Promise<StateGetAuctionInfoResult>
Implementation of IClient.getAuctionInfoByHeight
- Defined in src/rpc/rpc_client.ts:801

getBalanceByStateRootHash

getBalanceByStateRootHash(purseURef: string, stateRootHash: string): Promise<StateGetBalanceResult>
Parameters
- purseURef: string
- stateRootHash: string
Returns Promise<StateGetBalanceResult>
Implementation of IClient.getBalanceByStateRootHash
- Defined in src/rpc/rpc_client.ts:555

getBlockByHash

getBlockByHash(hash: string): Promise<ChainGetBlockResult>
Parameters
- hash: string
Returns Promise<ChainGetBlockResult>
Implementation of IClient.getBlockByHash
- Defined in src/rpc/rpc_client.ts:632

getBlockByHeight

getBlockByHeight(height: number): Promise<ChainGetBlockResult>
Parameters
- height: number
Returns Promise<ChainGetBlockResult>
Implementation of IClient.getBlockByHeight
- Defined in src/rpc/rpc_client.ts:656

getBlockTransfersByHash

getBlockTransfersByHash(blockHash: string): Promise<ChainGetBlockTransfersResult>
Parameters
- blockHash: string
Returns Promise<ChainGetBlockTransfersResult>
Implementation of IClient.getBlockTransfersByHash
- Defined in src/rpc/rpc_client.ts:692

getBlockTransfersByHeight

getBlockTransfersByHeight(height: number): Promise<ChainGetBlockTransfersResult>
Parameters
- height: number
Returns Promise<ChainGetBlockTransfersResult>
Implementation of IClient.getBlockTransfersByHeight
- Defined in src/rpc/rpc_client.ts:712

getChainspec

getChainspec(): Promise<InfoGetChainspecResult>
Returns Promise<InfoGetChainspecResult>
Implementation of IClient.getChainspec
- Defined in src/rpc/rpc_client.ts:1085

getDelegatorRewardByBlockHash

getDelegatorRewardByBlockHash(validator: PublicKey, delegator: PublicKey, blockHash: string): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
- delegator: PublicKey
- blockHash: string
Returns Promise<InfoGetRewardResult>
Implementation of IClient.getDelegatorRewardByBlockHash
- Defined in src/rpc/rpc_client.ts:1183

getDelegatorRewardByBlockHeight

getDelegatorRewardByBlockHeight(validator: PublicKey, delegator: PublicKey, height: number): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
- delegator: PublicKey
- height: number
Returns Promise<InfoGetRewardResult>
Implementation of IClient.getDelegatorRewardByBlockHeight
- Defined in src/rpc/rpc_client.ts:1206

getDelegatorRewardByEraID

getDelegatorRewardByEraID(validator: PublicKey, delegator: PublicKey, eraID: number): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
- delegator: PublicKey
- eraID: number
Returns Promise<InfoGetRewardResult>
Implementation of IClient.getDelegatorRewardByEraID
- Defined in src/rpc/rpc_client.ts:1160

getDeploy

getDeploy(hash: string): Promise<InfoGetDeployResult>
Parameters
- hash: string
Returns Promise<InfoGetDeployResult>
Implementation of IClient.getDeploy
- Defined in src/rpc/rpc_client.ts:75

getDeployFinalizedApproval

getDeployFinalizedApproval(hash: string): Promise<InfoGetDeployResult>
Parameters
- hash: string
Returns Promise<InfoGetDeployResult>
Implementation of IClient.getDeployFinalizedApproval
- Defined in src/rpc/rpc_client.ts:90

getDictionaryItem

getDictionaryItem(stateRootHash: null | string, uref: string, key: string): Promise<StateGetDictionaryResult>
Parameters
- stateRootHash: null | string
- uref: string
- key: string
Returns Promise<StateGetDictionaryResult>
Implementation of IClient.getDictionaryItem
- Defined in src/rpc/rpc_client.ts:493

getDictionaryItemByIdentifier

getDictionaryItemByIdentifier(stateRootHash: null | string, identifier: ParamDictionaryIdentifier): Promise<StateGetDictionaryResult>
Parameters
- stateRootHash: null | string
- identifier: ParamDictionaryIdentifier
Returns Promise<StateGetDictionaryResult>
Implementation of IClient.getDictionaryItemByIdentifier
- Defined in src/rpc/rpc_client.ts:508

getEntityByBlockHash

getEntityByBlockHash(entityIdentifier: EntityIdentifier, hash: string): Promise<StateGetEntityResult>
Parameters
- entityIdentifier: EntityIdentifier
- hash: string
Returns Promise<StateGetEntityResult>
Implementation of IClient.getEntityByBlockHash
- Defined in src/rpc/rpc_client.ts:372

getEntityByBlockHeight

getEntityByBlockHeight(entityIdentifier: EntityIdentifier, height: number): Promise<StateGetEntityResult>
Parameters
- entityIdentifier: EntityIdentifier
- height: number
Returns Promise<StateGetEntityResult>
Implementation of IClient.getEntityByBlockHeight
- Defined in src/rpc/rpc_client.ts:393

getEraInfoByBlockHash

getEraInfoByBlockHash(hash: string): Promise<ChainGetEraInfoResult>
Parameters
- hash: string
Returns Promise<ChainGetEraInfoResult>
Implementation of IClient.getEraInfoByBlockHash
- Defined in src/rpc/rpc_client.ts:599

getEraInfoByBlockHeight

getEraInfoByBlockHeight(height: number): Promise<ChainGetEraInfoResult>
Parameters
- height: number
Returns Promise<ChainGetEraInfoResult>
Implementation of IClient.getEraInfoByBlockHeight
- Defined in src/rpc/rpc_client.ts:582

getEraInfoLatest

getEraInfoLatest(): Promise<ChainGetEraInfoResult>
Returns Promise<ChainGetEraInfoResult>
Implementation of IClient.getEraInfoLatest
- Defined in src/rpc/rpc_client.ts:573

getEraSummaryByHash

getEraSummaryByHash(blockHash: string): Promise<ChainGetEraSummaryResult>
Parameters
- blockHash: string
Returns Promise<ChainGetEraSummaryResult>
Implementation of IClient.getEraSummaryByHash
- Defined in src/rpc/rpc_client.ts:741

getEraSummaryByHeight

getEraSummaryByHeight(height: number): Promise<ChainGetEraSummaryResult>
Parameters
- height: number
Returns Promise<ChainGetEraSummaryResult>
Implementation of IClient.getEraSummaryByHeight
- Defined in src/rpc/rpc_client.ts:758

getEraSummaryLatest

getEraSummaryLatest(): Promise<ChainGetEraSummaryResult>
Returns Promise<ChainGetEraSummaryResult>
Implementation of IClient.getEraSummaryLatest
- Defined in src/rpc/rpc_client.ts:732

getLatestAuctionInfo

getLatestAuctionInfo(): Promise<StateGetAuctionInfoResult>
Returns Promise<StateGetAuctionInfoResult>
Implementation of IClient.getLatestAuctionInfo
- Defined in src/rpc/rpc_client.ts:775

getLatestBalance

getLatestBalance(purseURef: string): Promise<StateGetBalanceResult>
Parameters
- purseURef: string
Returns Promise<StateGetBalanceResult>
Implementation of IClient.getLatestBalance
- Defined in src/rpc/rpc_client.ts:536

getLatestBlock

getLatestBlock(): Promise<ChainGetBlockResult>
Returns Promise<ChainGetBlockResult>
Implementation of IClient.getLatestBlock
- Defined in src/rpc/rpc_client.ts:614

getLatestBlockTransfers

getLatestBlockTransfers(): Promise<ChainGetBlockTransfersResult>
Returns Promise<ChainGetBlockTransfersResult>
Implementation of IClient.getLatestBlockTransfers
- Defined in src/rpc/rpc_client.ts:680

getLatestDelegatorReward

getLatestDelegatorReward(validator: PublicKey, delegator: PublicKey): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
- delegator: PublicKey
Returns Promise<InfoGetRewardResult>
Implementation of IClient.getLatestDelegatorReward
- Defined in src/rpc/rpc_client.ts:1246

getLatestEntity

getLatestEntity(entityIdentifier: EntityIdentifier): Promise<StateGetEntityResult>
Parameters
- entityIdentifier: EntityIdentifier
Returns Promise<StateGetEntityResult>
Implementation of IClient.getLatestEntity
- Defined in src/rpc/rpc_client.ts:355

getLatestValidatorReward

getLatestValidatorReward(validator: PublicKey): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
Returns Promise<InfoGetRewardResult>
Implementation of IClient.getLatestValidatorReward
- Defined in src/rpc/rpc_client.ts:1229

getPeers

getPeers(): Promise<InfoGetPeerResult>
Returns Promise<InfoGetPeerResult>
Implementation of IClient.getPeers
- Defined in src/rpc/rpc_client.ts:882

getStateItem

getStateItem(stateRootHash: null | string, key: string, path: string[]): Promise<StateGetItemResult>
Parameters
- stateRootHash: null | string
- key: string
- path: string[]
Returns Promise<StateGetItemResult>
Implementation of IClient.getStateItem
- Defined in src/rpc/rpc_client.ts:223

getStateRootHashByHash

getStateRootHashByHash(blockHash: string): Promise<ChainGetStateRootHashResult>
Parameters
- blockHash: string
Returns Promise<ChainGetStateRootHashResult>
Implementation of IClient.getStateRootHashByHash
- Defined in src/rpc/rpc_client.ts:827

getStateRootHashByHeight

getStateRootHashByHeight(height: number): Promise<ChainGetStateRootHashResult>
Parameters
- height: number
Returns Promise<ChainGetStateRootHashResult>
Implementation of IClient.getStateRootHashByHeight
- Defined in src/rpc/rpc_client.ts:844

getStateRootHashLatest

getStateRootHashLatest(): Promise<ChainGetStateRootHashResult>
Returns Promise<ChainGetStateRootHashResult>
Implementation of IClient.getStateRootHashLatest
- Defined in src/rpc/rpc_client.ts:818

getStatus

getStatus(): Promise<InfoGetStatusResult>
Returns Promise<InfoGetStatusResult>
Implementation of IClient.getStatus
- Defined in src/rpc/rpc_client.ts:873

getTransactionByDeployHash

getTransactionByDeployHash(deployHash: string): Promise<InfoGetTransactionResult>
Parameters
- deployHash: string
Returns Promise<InfoGetTransactionResult>
Implementation of IClient.getTransactionByDeployHash
- Defined in src/rpc/rpc_client.ts:134

getTransactionByTransactionHash

getTransactionByTransactionHash(transactionHash: string): Promise<InfoGetTransactionResult>
Parameters
- transactionHash: string
Returns Promise<InfoGetTransactionResult>
Implementation of IClient.getTransactionByTransactionHash
- Defined in src/rpc/rpc_client.ts:105

getTransactionFinalizedApprovalByDeployHash

getTransactionFinalizedApprovalByDeployHash(deployHash: string): Promise<InfoGetTransactionResult>
Parameters
- deployHash: string
Returns Promise<InfoGetTransactionResult>
Implementation of IClient.getTransactionFinalizedApprovalByDeployHash
- Defined in src/rpc/rpc_client.ts:193

getTransactionFinalizedApprovalByTransactionHash

getTransactionFinalizedApprovalByTransactionHash(transactionHash: string): Promise<InfoGetTransactionResult>
Parameters
- transactionHash: string
Returns Promise<InfoGetTransactionResult>
Implementation of IClient.getTransactionFinalizedApprovalByTransactionHash
- Defined in src/rpc/rpc_client.ts:163

getValidatorChangesInfo

getValidatorChangesInfo(): Promise<InfoGetValidatorChangesResult>
Returns Promise<InfoGetValidatorChangesResult>
Implementation of IClient.getValidatorChangesInfo
- Defined in src/rpc/rpc_client.ts:861

getValidatorRewardByBlockHash

getValidatorRewardByBlockHash(validator: PublicKey, blockHash: string): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
- blockHash: string
Returns Promise<InfoGetRewardResult>
Implementation of IClient.getValidatorRewardByBlockHash
- Defined in src/rpc/rpc_client.ts:1116

getValidatorRewardByBlockHeight

getValidatorRewardByBlockHeight(validator: PublicKey, height: number): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
- height: number
Returns Promise<InfoGetRewardResult>
Implementation of IClient.getValidatorRewardByBlockHeight
- Defined in src/rpc/rpc_client.ts:1138

getValidatorRewardByEraID

getValidatorRewardByEraID(validator: PublicKey, eraID: number): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
- eraID: number
Returns Promise<InfoGetRewardResult>
Implementation of IClient.getValidatorRewardByEraID
- Defined in src/rpc/rpc_client.ts:1094

`Private` parseResponse

parseResponse<T>(type: (new (params: any) => T), response: any): T
Type Parameters
- T
Parameters
- type: (new (params: any) => T)
  - - new (params: any): T
    - Parameters
      
      params: any
      
      Returns T
- response: any
Returns T
- Defined in src/rpc/rpc_client.ts:1264

`Private` processRequest

processRequest<Request>(method: Method, params: Request, reqID?: string): Promise<RpcResponse>
Type Parameters
- Request
Parameters
- method: Method
- params: Request
- reqID: string = '0'
Returns Promise<RpcResponse>
- Defined in src/rpc/rpc_client.ts:1273

putDeploy

putDeploy(deploy: Deploy): Promise<PutDeployResult>
Parameters
- deploy: Deploy
Returns Promise<PutDeployResult>
Implementation of IClient.putDeploy
- Defined in src/rpc/rpc_client.ts:891

putTransaction

putTransaction(transaction: Transaction): Promise<PutTransactionResult>
Parameters
- transaction: Transaction
Returns Promise<PutTransactionResult>
Implementation of IClient.putTransaction
- Defined in src/rpc/rpc_client.ts:906

queryBalanceByBlockHash

queryBalanceByBlockHash(purseIdentifier: PurseIdentifier, blockHash: string): Promise<QueryBalanceResult>
Parameters
- purseIdentifier: PurseIdentifier
- blockHash: string
Returns Promise<QueryBalanceResult>
Implementation of IClient.queryBalanceByBlockHash
- Defined in src/rpc/rpc_client.ts:963

queryBalanceByBlockHeight

queryBalanceByBlockHeight(purseIdentifier: PurseIdentifier, height: number): Promise<QueryBalanceResult>
Parameters
- purseIdentifier: PurseIdentifier
- height: number
Returns Promise<QueryBalanceResult>
Implementation of IClient.queryBalanceByBlockHeight
- Defined in src/rpc/rpc_client.ts:942

queryBalanceByStateRootHash

queryBalanceByStateRootHash(purseIdentifier: PurseIdentifier, stateRootHash: string): Promise<QueryBalanceResult>
Parameters
- purseIdentifier: PurseIdentifier
- stateRootHash: string
Returns Promise<QueryBalanceResult>
Implementation of IClient.queryBalanceByStateRootHash
- Defined in src/rpc/rpc_client.ts:984

queryBalanceDetailsByBlockHash

queryBalanceDetailsByBlockHash(purseIdentifier: PurseIdentifier, blockHash: string): Promise<QueryBalanceDetailsResult>
Parameters
- purseIdentifier: PurseIdentifier
- blockHash: string
Returns Promise<QueryBalanceDetailsResult>
Implementation of IClient.queryBalanceDetailsByBlockHash
- Defined in src/rpc/rpc_client.ts:1064

queryBalanceDetailsByBlockHeight

queryBalanceDetailsByBlockHeight(purseIdentifier: PurseIdentifier, height: number): Promise<QueryBalanceDetailsResult>
Parameters
- purseIdentifier: PurseIdentifier
- height: number
Returns Promise<QueryBalanceDetailsResult>
Implementation of IClient.queryBalanceDetailsByBlockHeight
- Defined in src/rpc/rpc_client.ts:1043

queryBalanceDetailsByStateRootHash

queryBalanceDetailsByStateRootHash(purseIdentifier: PurseIdentifier, stateRootHash: string): Promise<QueryBalanceDetailsResult>
Parameters
- purseIdentifier: PurseIdentifier
- stateRootHash: string
Returns Promise<QueryBalanceDetailsResult>
Implementation of IClient.queryBalanceDetailsByStateRootHash
- Defined in src/rpc/rpc_client.ts:1022

queryGlobalStateByBlockHash

queryGlobalStateByBlockHash(blockHash: string, key: string, path: string[]): Promise<QueryGlobalStateResult>
Parameters
- blockHash: string
- key: string
- path: string[]
Returns Promise<QueryGlobalStateResult>
Implementation of IClient.queryGlobalStateByBlockHash
- Defined in src/rpc/rpc_client.ts:270

queryGlobalStateByBlockHeight

queryGlobalStateByBlockHeight(blockHeight: number, key: string, path: string[]): Promise<QueryGlobalStateResult>
Parameters
- blockHeight: number
- key: string
- path: string[]
Returns Promise<QueryGlobalStateResult>
Implementation of IClient.queryGlobalStateByBlockHeight
- Defined in src/rpc/rpc_client.ts:293

queryGlobalStateByStateHash

queryGlobalStateByStateHash(stateRootHash: null | string, key: string, path: string[]): Promise<QueryGlobalStateResult>
Parameters
- stateRootHash: null | string
- key: string
- path: string[]
Returns Promise<QueryGlobalStateResult>
Implementation of IClient.queryGlobalStateByStateHash
- Defined in src/rpc/rpc_client.ts:316

queryLatestBalance

queryLatestBalance(identifier: PurseIdentifier): Promise<QueryBalanceResult>
Parameters
- identifier: PurseIdentifier
Returns Promise<QueryBalanceResult>
Implementation of IClient.queryLatestBalance
- Defined in src/rpc/rpc_client.ts:925

queryLatestBalanceDetails

queryLatestBalanceDetails(purseIdentifier: PurseIdentifier): Promise<QueryBalanceDetailsResult>
Parameters
- purseIdentifier: PurseIdentifier
Returns Promise<QueryBalanceDetailsResult>
Implementation of IClient.queryLatestBalanceDetails
- Defined in src/rpc/rpc_client.ts:1005

queryLatestGlobalState

queryLatestGlobalState(key: string, path: string[]): Promise<QueryGlobalStateResult>
Parameters
- key: string
- path: string[]
Returns Promise<QueryGlobalStateResult>
Implementation of IClient.queryLatestGlobalState
- Defined in src/rpc/rpc_client.ts:249

Generated using TypeDoc