Interface ClientInformational

Hierarchy

ClientInformational
- IClient

Index

Methods

getAccountInfo getAccountInfoByBlockHash getAccountInfoByBlockHeight getBalanceByStateRootHash getBlockByHash getBlockByHeight getBlockTransfersByHash getBlockTransfersByHeight getChainspec getDelegatorRewardByBlockHash getDelegatorRewardByBlockHeight getDelegatorRewardByEraID getDeploy getDeployFinalizedApproval getDictionaryItem getDictionaryItemByIdentifier getEntityByBlockHash getEntityByBlockHeight getEraSummaryByHash getEraSummaryByHeight getEraSummaryLatest getLatestBalance getLatestBlock getLatestBlockTransfers getLatestDelegatorReward getLatestEntity getLatestValidatorReward getPeers getStateItem getStateRootHashByHash getStateRootHashByHeight getStateRootHashLatest getStatus getTransactionByDeployHash getTransactionByTransactionHash getTransactionFinalizedApprovalByDeployHash getTransactionFinalizedApprovalByTransactionHash getValidatorRewardByBlockHash getValidatorRewardByBlockHeight getValidatorRewardByEraID 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>
- Defined in src/rpc/client.ts:200

getAccountInfoByBlockHash

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

getAccountInfoByBlockHeight

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

getBalanceByStateRootHash

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

getBlockByHash

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

getBlockByHeight

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

getBlockTransfersByHash

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

getBlockTransfersByHeight

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

getChainspec

getChainspec(): Promise<InfoGetChainspecResult>
Returns Promise<InfoGetChainspecResult>
- Defined in src/rpc/client.ts:274

getDelegatorRewardByBlockHash

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

getDelegatorRewardByBlockHeight

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

getDelegatorRewardByEraID

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

getDeploy

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

getDeployFinalizedApproval

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

getDictionaryItem

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

getDictionaryItemByIdentifier

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

getEntityByBlockHash

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

getEntityByBlockHeight

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

getEraSummaryByHash

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

getEraSummaryByHeight

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

getEraSummaryLatest

getEraSummaryLatest(): Promise<ChainGetEraSummaryResult>
Returns Promise<ChainGetEraSummaryResult>
- Defined in src/rpc/client.ts:229

getLatestBalance

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

getLatestBlock

getLatestBlock(): Promise<ChainGetBlockResult>
Returns Promise<ChainGetBlockResult>
- Defined in src/rpc/client.ts:217

getLatestBlockTransfers

getLatestBlockTransfers(): Promise<ChainGetBlockTransfersResult>
Returns Promise<ChainGetBlockTransfersResult>
- Defined in src/rpc/client.ts:221

getLatestDelegatorReward

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

getLatestEntity

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

getLatestValidatorReward

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

getPeers

getPeers(): Promise<InfoGetPeerResult>
Returns Promise<InfoGetPeerResult>
- Defined in src/rpc/client.ts:242

getStateItem

getStateItem(stateRootHash: null | string, key: string, path: string[]): Promise<StateGetItemResult>
⚠️ Deprecated: getStateItem is deprecated and will be removed in a future release.

Use queryLatestGlobalState, queryGlobalStateByBlockHash, queryGlobalStateByBlockHeight, or queryGlobalStateByStateHash instead.

Reason: The newer Global State Query API provides more consistent behavior across block identifiers and supports both stored values and typed keys.

Deprecated
Use Global State Query methods instead.
Parameters
- stateRootHash: null | string
- key: string
- path: string[]
Returns Promise<StateGetItemResult>
- Defined in src/rpc/client.ts:166

getStateRootHashByHash

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

getStateRootHashByHeight

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

getStateRootHashLatest

getStateRootHashLatest(): Promise<ChainGetStateRootHashResult>
Returns Promise<ChainGetStateRootHashResult>
- Defined in src/rpc/client.ts:233

getStatus

getStatus(): Promise<InfoGetStatusResult>
Returns Promise<InfoGetStatusResult>
- Defined in src/rpc/client.ts:241

getTransactionByDeployHash

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

getTransactionByTransactionHash

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

getTransactionFinalizedApprovalByDeployHash

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

getTransactionFinalizedApprovalByTransactionHash

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

getValidatorRewardByBlockHash

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

getValidatorRewardByBlockHeight

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

getValidatorRewardByEraID

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

queryBalanceByBlockHash

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

queryBalanceByBlockHeight

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

queryBalanceByStateRootHash

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

queryBalanceDetailsByBlockHash

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

queryBalanceDetailsByBlockHeight

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

queryBalanceDetailsByStateRootHash

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

queryGlobalStateByBlockHash

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

queryGlobalStateByBlockHeight

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

queryGlobalStateByStateHash

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

queryLatestBalance

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

queryLatestBalanceDetails

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

queryLatestGlobalState

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

Interface ClientInformational

Hierarchy

Index

Methods

Methods

getAccountInfo

Parameters

blockIdentifier: null | ParamBlockIdentifier

accountIdentifier: AccountIdentifier

Returns Promise<StateGetAccountInfo>

getAccountInfoByBlockHash

Parameters

blockHash: string

pub: PublicKey

Returns Promise<StateGetAccountInfo>

getAccountInfoByBlockHeight

Parameters

blockHeight: number

pub: PublicKey

Returns Promise<StateGetAccountInfo>

getBalanceByStateRootHash

Parameters

purseURef: string

stateRootHash: string

Returns Promise<StateGetBalanceResult>

getBlockByHash

Parameters

hash: string

Returns Promise<ChainGetBlockResult>

getBlockByHeight

Parameters

height: number

Returns Promise<ChainGetBlockResult>

getBlockTransfersByHash

Parameters

blockHash: string

Returns Promise<ChainGetBlockTransfersResult>

getBlockTransfersByHeight

Parameters

height: number

Returns Promise<ChainGetBlockTransfersResult>

getChainspec

Returns Promise<InfoGetChainspecResult>

getDelegatorRewardByBlockHash

Parameters

validator: PublicKey

delegator: PublicKey

blockHash: string

Returns Promise<InfoGetRewardResult>

getDelegatorRewardByBlockHeight

Parameters

validator: PublicKey

delegator: PublicKey

height: number

Returns Promise<InfoGetRewardResult>

getDelegatorRewardByEraID

Parameters

validator: PublicKey

delegator: PublicKey

eraID: number

Returns Promise<InfoGetRewardResult>

getDeploy

Parameters

hash: string

Returns Promise<InfoGetDeployResult>

getDeployFinalizedApproval

Parameters

hash: string

Returns Promise<InfoGetDeployResult>

getDictionaryItem

Parameters

stateRootHash: null | string

uref: string

key: string

Returns Promise<StateGetDictionaryResult>

getDictionaryItemByIdentifier

Parameters

stateRootHash: null | string

identifier: ParamDictionaryIdentifier

Returns Promise<StateGetDictionaryResult>