Interface IClient

Hierarchy

Implemented by

RpcClient

Index

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 putDeploy putTransaction queryBalanceByBlockHash queryBalanceByBlockHeight queryBalanceByStateRootHash queryBalanceDetailsByBlockHash queryBalanceDetailsByBlockHeight queryBalanceDetailsByStateRootHash queryGlobalStateByBlockHash queryGlobalStateByBlockHeight queryGlobalStateByStateHash queryLatestBalance queryLatestBalanceDetails queryLatestGlobalState

Methods

getAccountInfo

getAccountInfo(blockIdentifier: null | ParamBlockIdentifier, accountIdentifier: AccountIdentifier): Promise<StateGetAccountInfo>
Parameters
- blockIdentifier: null | ParamBlockIdentifier
- accountIdentifier: AccountIdentifier
Returns Promise<StateGetAccountInfo>
Inherited from ClientInformational.getAccountInfo
- Defined in src/rpc/client.ts:116

getAccountInfoByBlockHash

getAccountInfoByBlockHash(blockHash: string, pub: PublicKey): Promise<StateGetAccountInfo>
Parameters
- blockHash: string
- pub: PublicKey
Returns Promise<StateGetAccountInfo>
Inherited from ClientInformational.getAccountInfoByBlockHash
- Defined in src/rpc/client.ts:108

getAccountInfoByBlockHeight

getAccountInfoByBlockHeight(blockHeight: number, pub: PublicKey): Promise<StateGetAccountInfo>
Parameters
- blockHeight: number
- pub: PublicKey
Returns Promise<StateGetAccountInfo>
Inherited from ClientInformational.getAccountInfoByBlockHeight
- Defined in src/rpc/client.ts:112

getAuctionInfoByHash

getAuctionInfoByHash(blockHash: string): Promise<StateGetAuctionInfoResult>
Parameters
- blockHash: string
Returns Promise<StateGetAuctionInfoResult>
Inherited from ClientPOS.getAuctionInfoByHash
- Defined in src/rpc/client.ts:42

getAuctionInfoByHeight

getAuctionInfoByHeight(height: number): Promise<StateGetAuctionInfoResult>
Parameters
- height: number
Returns Promise<StateGetAuctionInfoResult>
Inherited from ClientPOS.getAuctionInfoByHeight
- Defined in src/rpc/client.ts:43

getBalanceByStateRootHash

getBalanceByStateRootHash(purseURef: string, stateRootHash: string): Promise<StateGetBalanceResult>
Parameters
- purseURef: string
- stateRootHash: string
Returns Promise<StateGetBalanceResult>
Inherited from ClientInformational.getBalanceByStateRootHash
- Defined in src/rpc/client.ts:54

getBlockByHash

getBlockByHash(hash: string): Promise<ChainGetBlockResult>
Parameters
- hash: string
Returns Promise<ChainGetBlockResult>
Inherited from ClientInformational.getBlockByHash
- Defined in src/rpc/client.ts:134

getBlockByHeight

getBlockByHeight(height: number): Promise<ChainGetBlockResult>
Parameters
- height: number
Returns Promise<ChainGetBlockResult>
Inherited from ClientInformational.getBlockByHeight
- Defined in src/rpc/client.ts:135

getBlockTransfersByHash

getBlockTransfersByHash(blockHash: string): Promise<ChainGetBlockTransfersResult>
Parameters
- blockHash: string
Returns Promise<ChainGetBlockTransfersResult>
Inherited from ClientInformational.getBlockTransfersByHash
- Defined in src/rpc/client.ts:138

getBlockTransfersByHeight

getBlockTransfersByHeight(height: number): Promise<ChainGetBlockTransfersResult>
Parameters
- height: number
Returns Promise<ChainGetBlockTransfersResult>
Inherited from ClientInformational.getBlockTransfersByHeight
- Defined in src/rpc/client.ts:141

getChainspec

getChainspec(): Promise<InfoGetChainspecResult>
Returns Promise<InfoGetChainspecResult>
Inherited from ClientInformational.getChainspec
- Defined in src/rpc/client.ts:190

getDelegatorRewardByBlockHash

getDelegatorRewardByBlockHash(validator: PublicKey, delegator: PublicKey, blockHash: string): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
- delegator: PublicKey
- blockHash: string
Returns Promise<InfoGetRewardResult>
Inherited from ClientInformational.getDelegatorRewardByBlockHash
- Defined in src/rpc/client.ts:215

getDelegatorRewardByBlockHeight

getDelegatorRewardByBlockHeight(validator: PublicKey, delegator: PublicKey, height: number): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
- delegator: PublicKey
- height: number
Returns Promise<InfoGetRewardResult>
Inherited from ClientInformational.getDelegatorRewardByBlockHeight
- Defined in src/rpc/client.ts:220

getDelegatorRewardByEraID

getDelegatorRewardByEraID(validator: PublicKey, delegator: PublicKey, eraID: number): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
- delegator: PublicKey
- eraID: number
Returns Promise<InfoGetRewardResult>
Inherited from ClientInformational.getDelegatorRewardByEraID
- Defined in src/rpc/client.ts:210

getDeploy

getDeploy(hash: string): Promise<InfoGetDeployResult>
Parameters
- hash: string
Returns Promise<InfoGetDeployResult>
Inherited from ClientInformational.getDeploy
- Defined in src/rpc/client.ts:58

getDeployFinalizedApproval

getDeployFinalizedApproval(hash: string): Promise<InfoGetDeployResult>
Parameters
- hash: string
Returns Promise<InfoGetDeployResult>
Inherited from ClientInformational.getDeployFinalizedApproval
- Defined in src/rpc/client.ts:59

getDictionaryItem

getDictionaryItem(stateRootHash: null | string, uref: string, key: string): Promise<StateGetDictionaryResult>
Parameters
- stateRootHash: null | string
- uref: string
- key: string
Returns Promise<StateGetDictionaryResult>
Inherited from ClientInformational.getDictionaryItem
- Defined in src/rpc/client.ts:73

getDictionaryItemByIdentifier

getDictionaryItemByIdentifier(stateRootHash: null | string, identifier: ParamDictionaryIdentifier): Promise<StateGetDictionaryResult>
Parameters
- stateRootHash: null | string
- identifier: ParamDictionaryIdentifier
Returns Promise<StateGetDictionaryResult>
Inherited from ClientInformational.getDictionaryItemByIdentifier
- Defined in src/rpc/client.ts:78

getEntityByBlockHash

getEntityByBlockHash(entityIdentifier: EntityIdentifier, hash: string): Promise<StateGetEntityResult>
Parameters
- entityIdentifier: EntityIdentifier
- hash: string
Returns Promise<StateGetEntityResult>
Inherited from ClientInformational.getEntityByBlockHash
- Defined in src/rpc/client.ts:124

getEntityByBlockHeight

getEntityByBlockHeight(entityIdentifier: EntityIdentifier, height: number): Promise<StateGetEntityResult>
Parameters
- entityIdentifier: EntityIdentifier
- height: number
Returns Promise<StateGetEntityResult>
Inherited from ClientInformational.getEntityByBlockHeight
- Defined in src/rpc/client.ts:128

getEraInfoByBlockHash

getEraInfoByBlockHash(hash: string): Promise<ChainGetEraInfoResult>
Parameters
- hash: string
Returns Promise<ChainGetEraInfoResult>
Inherited from ClientPOS.getEraInfoByBlockHash
- Defined in src/rpc/client.ts:47

getEraInfoByBlockHeight

getEraInfoByBlockHeight(height: number): Promise<ChainGetEraInfoResult>
Parameters
- height: number
Returns Promise<ChainGetEraInfoResult>
Inherited from ClientPOS.getEraInfoByBlockHeight
- Defined in src/rpc/client.ts:46

getEraInfoLatest

getEraInfoLatest(): Promise<ChainGetEraInfoResult>
Returns Promise<ChainGetEraInfoResult>
Inherited from ClientPOS.getEraInfoLatest
- Defined in src/rpc/client.ts:45

getEraSummaryByHash

getEraSummaryByHash(blockHash: string): Promise<ChainGetEraSummaryResult>
Parameters
- blockHash: string
Returns Promise<ChainGetEraSummaryResult>
Inherited from ClientInformational.getEraSummaryByHash
- Defined in src/rpc/client.ts:146

getEraSummaryByHeight

getEraSummaryByHeight(height: number): Promise<ChainGetEraSummaryResult>
Parameters
- height: number
Returns Promise<ChainGetEraSummaryResult>
Inherited from ClientInformational.getEraSummaryByHeight
- Defined in src/rpc/client.ts:147

getEraSummaryLatest

getEraSummaryLatest(): Promise<ChainGetEraSummaryResult>
Returns Promise<ChainGetEraSummaryResult>
Inherited from ClientInformational.getEraSummaryLatest
- Defined in src/rpc/client.ts:145

getLatestAuctionInfo

getLatestAuctionInfo(): Promise<StateGetAuctionInfoResult>
Returns Promise<StateGetAuctionInfoResult>
Inherited from ClientPOS.getLatestAuctionInfo
- Defined in src/rpc/client.ts:41

getLatestBalance

getLatestBalance(purseURef: string): Promise<StateGetBalanceResult>
Parameters
- purseURef: string
Returns Promise<StateGetBalanceResult>
Inherited from ClientInformational.getLatestBalance
- Defined in src/rpc/client.ts:53

getLatestBlock

getLatestBlock(): Promise<ChainGetBlockResult>
Returns Promise<ChainGetBlockResult>
Inherited from ClientInformational.getLatestBlock
- Defined in src/rpc/client.ts:133

getLatestBlockTransfers

getLatestBlockTransfers(): Promise<ChainGetBlockTransfersResult>
Returns Promise<ChainGetBlockTransfersResult>
Inherited from ClientInformational.getLatestBlockTransfers
- Defined in src/rpc/client.ts:137

getLatestDelegatorReward

getLatestDelegatorReward(validator: PublicKey, delegator: PublicKey): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
- delegator: PublicKey
Returns Promise<InfoGetRewardResult>
Inherited from ClientInformational.getLatestDelegatorReward
- Defined in src/rpc/client.ts:206

getLatestEntity

getLatestEntity(entityIdentifier: EntityIdentifier): Promise<StateGetEntityResult>
Parameters
- entityIdentifier: EntityIdentifier
Returns Promise<StateGetEntityResult>
Inherited from ClientInformational.getLatestEntity
- Defined in src/rpc/client.ts:121

getLatestValidatorReward

getLatestValidatorReward(validator: PublicKey): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
Returns Promise<InfoGetRewardResult>
Inherited from ClientInformational.getLatestValidatorReward
- Defined in src/rpc/client.ts:192

getPeers

getPeers(): Promise<InfoGetPeerResult>
Returns Promise<InfoGetPeerResult>
Inherited from ClientInformational.getPeers
- Defined in src/rpc/client.ts:158

getStateItem

getStateItem(stateRootHash: null | string, key: string, path: string[]): Promise<StateGetItemResult>
Parameters
- stateRootHash: null | string
- key: string
- path: string[]
Returns Promise<StateGetItemResult>
Inherited from ClientInformational.getStateItem
- Defined in src/rpc/client.ts:82

getStateRootHashByHash

getStateRootHashByHash(blockHash: string): Promise<ChainGetStateRootHashResult>
Parameters
- blockHash: string
Returns Promise<ChainGetStateRootHashResult>
Inherited from ClientInformational.getStateRootHashByHash
- Defined in src/rpc/client.ts:150

getStateRootHashByHeight

getStateRootHashByHeight(height: number): Promise<ChainGetStateRootHashResult>
Parameters
- height: number
Returns Promise<ChainGetStateRootHashResult>
Inherited from ClientInformational.getStateRootHashByHeight
- Defined in src/rpc/client.ts:153

getStateRootHashLatest

getStateRootHashLatest(): Promise<ChainGetStateRootHashResult>
Returns Promise<ChainGetStateRootHashResult>
Inherited from ClientInformational.getStateRootHashLatest
- Defined in src/rpc/client.ts:149

getStatus

getStatus(): Promise<InfoGetStatusResult>
Returns Promise<InfoGetStatusResult>
Inherited from ClientInformational.getStatus
- Defined in src/rpc/client.ts:157

getTransactionByDeployHash

getTransactionByDeployHash(deployHash: string): Promise<InfoGetTransactionResult>
Parameters
- deployHash: string
Returns Promise<InfoGetTransactionResult>
Inherited from ClientInformational.getTransactionByDeployHash
- Defined in src/rpc/client.ts:63

getTransactionByTransactionHash

getTransactionByTransactionHash(transactionHash: string): Promise<InfoGetTransactionResult>
Parameters
- transactionHash: string
Returns Promise<InfoGetTransactionResult>
Inherited from ClientInformational.getTransactionByTransactionHash
- Defined in src/rpc/client.ts:60

getTransactionFinalizedApprovalByDeployHash

getTransactionFinalizedApprovalByDeployHash(deployHash: string): Promise<InfoGetTransactionResult>
Parameters
- deployHash: string
Returns Promise<InfoGetTransactionResult>
Inherited from ClientInformational.getTransactionFinalizedApprovalByDeployHash
- Defined in src/rpc/client.ts:69

getTransactionFinalizedApprovalByTransactionHash

getTransactionFinalizedApprovalByTransactionHash(transactionHash: string): Promise<InfoGetTransactionResult>
Parameters
- transactionHash: string
Returns Promise<InfoGetTransactionResult>
Inherited from ClientInformational.getTransactionFinalizedApprovalByTransactionHash
- Defined in src/rpc/client.ts:66

getValidatorChangesInfo

getValidatorChangesInfo(): Promise<InfoGetValidatorChangesResult>
Returns Promise<InfoGetValidatorChangesResult>
Inherited from ClientPOS.getValidatorChangesInfo
- Defined in src/rpc/client.ts:49

getValidatorRewardByBlockHash

getValidatorRewardByBlockHash(validator: PublicKey, blockHash: string): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
- blockHash: string
Returns Promise<InfoGetRewardResult>
Inherited from ClientInformational.getValidatorRewardByBlockHash
- Defined in src/rpc/client.ts:197

getValidatorRewardByBlockHeight

getValidatorRewardByBlockHeight(validator: PublicKey, height: number): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
- height: number
Returns Promise<InfoGetRewardResult>
Inherited from ClientInformational.getValidatorRewardByBlockHeight
- Defined in src/rpc/client.ts:201

getValidatorRewardByEraID

getValidatorRewardByEraID(validator: PublicKey, eraID: number): Promise<InfoGetRewardResult>
Parameters
- validator: PublicKey
- eraID: number
Returns Promise<InfoGetRewardResult>
Inherited from ClientInformational.getValidatorRewardByEraID
- Defined in src/rpc/client.ts:193

putDeploy

putDeploy(deploy: Deploy): Promise<PutDeployResult>
Parameters
- deploy: Deploy
Returns Promise<PutDeployResult>
Inherited from ClientTransactional.putDeploy
- Defined in src/rpc/client.ts:228

putTransaction

putTransaction(transaction: Transaction): Promise<PutTransactionResult>
Parameters
- transaction: Transaction
Returns Promise<PutTransactionResult>
Inherited from ClientTransactional.putTransaction
- Defined in src/rpc/client.ts:229

queryBalanceByBlockHash

queryBalanceByBlockHash(purseIdentifier: PurseIdentifier, blockHash: string): Promise<QueryBalanceResult>
Parameters
- purseIdentifier: PurseIdentifier
- blockHash: string
Returns Promise<QueryBalanceResult>
Inherited from ClientInformational.queryBalanceByBlockHash
- Defined in src/rpc/client.ts:165

queryBalanceByBlockHeight

queryBalanceByBlockHeight(purseIdentifier: PurseIdentifier, height: number): Promise<QueryBalanceResult>
Parameters
- purseIdentifier: PurseIdentifier
- height: number
Returns Promise<QueryBalanceResult>
Inherited from ClientInformational.queryBalanceByBlockHeight
- Defined in src/rpc/client.ts:161

queryBalanceByStateRootHash

queryBalanceByStateRootHash(purseIdentifier: PurseIdentifier, stateRootHash: string): Promise<QueryBalanceResult>
Parameters
- purseIdentifier: PurseIdentifier
- stateRootHash: string
Returns Promise<QueryBalanceResult>
Inherited from ClientInformational.queryBalanceByStateRootHash
- Defined in src/rpc/client.ts:169

queryBalanceDetailsByBlockHash

queryBalanceDetailsByBlockHash(purseIdentifier: PurseIdentifier, blockHash: string): Promise<QueryBalanceDetailsResult>
Parameters
- purseIdentifier: PurseIdentifier
- blockHash: string
Returns Promise<QueryBalanceDetailsResult>
Inherited from ClientInformational.queryBalanceDetailsByBlockHash
- Defined in src/rpc/client.ts:181

queryBalanceDetailsByBlockHeight

queryBalanceDetailsByBlockHeight(purseIdentifier: PurseIdentifier, height: number): Promise<QueryBalanceDetailsResult>
Parameters
- purseIdentifier: PurseIdentifier
- height: number
Returns Promise<QueryBalanceDetailsResult>
Inherited from ClientInformational.queryBalanceDetailsByBlockHeight
- Defined in src/rpc/client.ts:177

queryBalanceDetailsByStateRootHash

queryBalanceDetailsByStateRootHash(purseIdentifier: PurseIdentifier, stateRootHash: string): Promise<QueryBalanceDetailsResult>
Parameters
- purseIdentifier: PurseIdentifier
- stateRootHash: string
Returns Promise<QueryBalanceDetailsResult>
Inherited from ClientInformational.queryBalanceDetailsByStateRootHash
- Defined in src/rpc/client.ts:185

queryGlobalStateByBlockHash

queryGlobalStateByBlockHash(blockHash: string, key: string, path: string[]): Promise<QueryGlobalStateResult>
Parameters
- blockHash: string
- key: string
- path: string[]
Returns Promise<QueryGlobalStateResult>
Inherited from ClientInformational.queryGlobalStateByBlockHash
- Defined in src/rpc/client.ts:92

queryGlobalStateByBlockHeight

queryGlobalStateByBlockHeight(blockHeight: number, key: string, path: string[]): Promise<QueryGlobalStateResult>
Parameters
- blockHeight: number
- key: string
- path: string[]
Returns Promise<QueryGlobalStateResult>
Inherited from ClientInformational.queryGlobalStateByBlockHeight
- Defined in src/rpc/client.ts:97

queryGlobalStateByStateHash

queryGlobalStateByStateHash(stateRootHash: null | string, key: string, path: string[]): Promise<QueryGlobalStateResult>
Parameters
- stateRootHash: null | string
- key: string
- path: string[]
Returns Promise<QueryGlobalStateResult>
Inherited from ClientInformational.queryGlobalStateByStateHash
- Defined in src/rpc/client.ts:102

queryLatestBalance

queryLatestBalance(identifier: PurseIdentifier): Promise<QueryBalanceResult>
Parameters
- identifier: PurseIdentifier
Returns Promise<QueryBalanceResult>
Inherited from ClientInformational.queryLatestBalance
- Defined in src/rpc/client.ts:160

queryLatestBalanceDetails

queryLatestBalanceDetails(purseIdentifier: PurseIdentifier): Promise<QueryBalanceDetailsResult>
Parameters
- purseIdentifier: PurseIdentifier
Returns Promise<QueryBalanceDetailsResult>
Inherited from ClientInformational.queryLatestBalanceDetails
- Defined in src/rpc/client.ts:174

queryLatestGlobalState

queryLatestGlobalState(key: string, path: string[]): Promise<QueryGlobalStateResult>
Parameters
- key: string
- path: string[]
Returns Promise<QueryGlobalStateResult>
Inherited from ClientInformational.queryLatestGlobalState
- Defined in src/rpc/client.ts:88

Generated using TypeDoc