Class RpcClient

Hierarchy

RpcClient

Implements

IClient

Index

Constructors

constructor

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

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:458

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:418

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:438

getAuctionInfoByHash

getAuctionInfoByHash(blockHash: string): Promise<StateGetAuctionInfoResult>
Retrieves auction information by block hash, including Validator Bids and Era Validators.

Returns
A Promise resolving to the auction info.

Rpc
state_get_auction_info_v2 (fallback: state_get_auction_info)
Parameters
- blockHash: string
  
  The hash of the block to retrieve auction info for.
Returns Promise<StateGetAuctionInfoResult>
Implementation of IClient.getAuctionInfoByHash
- Defined in src/rpc/rpc_client.ts:821

getAuctionInfoByHeight

getAuctionInfoByHeight(height: number): Promise<StateGetAuctionInfoResult>
Retrieves auction information by block height, including Validator Bids and Era Validators.

Returns
A Promise resolving to the auction info.

Rpc
state_get_auction_info_v2 (fallback: state_get_auction_info)
Parameters
- height: number
  
  The height of the block to retrieve auction info for.
Returns Promise<StateGetAuctionInfoResult>
Implementation of IClient.getAuctionInfoByHeight
- Defined in src/rpc/rpc_client.ts:880

getAuctionInfoV1ByHash

getAuctionInfoV1ByHash(blockHash: string): Promise<StateGetAuctionInfoV1Result>
Retrieves auction information by block hash (version 1), including Validator Bids and Era Validators.

Returns
A Promise resolving to the auction info (V1).

Rpc
state_get_auction_info
Parameters
- blockHash: string
  
  The hash of the block to retrieve auction info for.
Returns Promise<StateGetAuctionInfoV1Result>
Implementation of IClient.getAuctionInfoV1ByHash
- Defined in src/rpc/rpc_client.ts:846

getAuctionInfoV1ByHeight

getAuctionInfoV1ByHeight(height: number): Promise<StateGetAuctionInfoV1Result>
Retrieves auction information by block height (version 1), including Validator Bids and Era Validators.

Returns
A Promise resolving to the auction info (V1).

Rpc
state_get_auction_info
Parameters
- height: number
  
  The height of the block to retrieve auction info for.
Returns Promise<StateGetAuctionInfoV1Result>
Implementation of IClient.getAuctionInfoV1ByHeight
- Defined in src/rpc/rpc_client.ts:905

getAuctionInfoV2ByHash

getAuctionInfoV2ByHash(blockHash: string): Promise<StateGetAuctionInfoV2Result>
Parameters
- blockHash: string
Returns Promise<StateGetAuctionInfoV2Result>
- Defined in src/rpc/rpc_client.ts:863

getAuctionInfoV2ByHeight

getAuctionInfoV2ByHeight(height: number): Promise<StateGetAuctionInfoV2Result>
Parameters
- height: number
Returns Promise<StateGetAuctionInfoV2Result>
- Defined in src/rpc/rpc_client.ts:922

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:556

getBlockByHash

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

getBlockByHeight

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

getBlockTransfersByHash

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

getBlockTransfersByHeight

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

getChainspec

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

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:1304

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:1327

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:1281

getDeploy

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

getDeployFinalizedApproval

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

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:494

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:509

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:376

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:397

getEraInfoByBlockHash

getEraInfoByBlockHash(hash: string): Promise<ChainGetEraInfoResult>
Retrieves EraInfo by block hash. Only the last block in an era (switch block) contains an era summary.

Returns
A Promise resolving to the EraInfo.
Parameters
- hash: string
  
  The hash of the block to retrieve EraInfo for.
Returns Promise<ChainGetEraInfoResult>
Implementation of IClient.getEraInfoByBlockHash
- Defined in src/rpc/rpc_client.ts:600

getEraInfoByBlockHeight

getEraInfoByBlockHeight(height: number): Promise<ChainGetEraInfoResult>
Retrieves EraInfo by block height. Only the last block in an era (switch block) contains an era summary.

Returns
A Promise resolving to the EraInfo.
Parameters
- height: number
  
  The height of the block to retrieve EraInfo for.
Returns Promise<ChainGetEraInfoResult>
Implementation of IClient.getEraInfoByBlockHeight
- Defined in src/rpc/rpc_client.ts:583

getEraInfoLatest

getEraInfoLatest(): Promise<ChainGetEraInfoResult>
Retrieves the latest EraInfo from the network. Only the last block in an era (switch block) contains an era summary. This method returns information about the latest block, which may not be the last block in the era.

Returns
A Promise resolving to the latest EraInfo.

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

getEraSummaryByHash

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

getEraSummaryByHeight

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

getEraSummaryLatest

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

getLatestAuctionInfo

getLatestAuctionInfo(): Promise<StateGetAuctionInfoResult>
Retrieves the latest auction information, including Validator Bids and Era Validators.

Returns
A Promise resolving to the latest auction info.

Rpc
state_get_auction_info_v2 (fallback: state_get_auction_info)

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

getLatestAuctionInfoV1

getLatestAuctionInfoV1(): Promise<StateGetAuctionInfoV1Result>
Retrieves the latest auction information (version 1), including Validator Bids and Era Validators.

Returns
A Promise resolving to the latest auction info (V1).

Rpc
state_get_auction_info

Returns Promise<StateGetAuctionInfoV1Result>
Implementation of IClient.getLatestAuctionInfoV1
- Defined in src/rpc/rpc_client.ts:803

getLatestAuctionInfoV2

getLatestAuctionInfoV2(): Promise<StateGetAuctionInfoV2Result>
Returns Promise<StateGetAuctionInfoV2Result>
- Defined in src/rpc/rpc_client.ts:812

getLatestBalance

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

getLatestBlock

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

getLatestBlockTransfers

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

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:1367

getLatestEntity

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

getLatestValidatorReward

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

getPeers

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

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:227

getStateRootHashByHash

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

getStateRootHashByHeight

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

getStateRootHashLatest

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

getStatus

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

getTransactionByDeployHash

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

getTransactionByTransactionHash

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

getTransactionFinalizedApprovalByDeployHash

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

getTransactionFinalizedApprovalByTransactionHash

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

getValidatorChangesInfo

getValidatorChangesInfo(): Promise<InfoGetValidatorChangesResult>
Retrieves status changes of active validators. The changes occurred during the EraId contained within the response itself. A validator may show more than one change in a single era.

Returns
A Promise resolving to validator status changes.

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

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:1237

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:1259

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:1215

`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:1472

`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:1481

putDeploy

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

putTransaction

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

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:1084

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:1063

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:1105

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:1185

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:1164

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:1143

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:274

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:297

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:320

queryLatestBalance

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

queryLatestBalanceDetails

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

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:253

`Private` waitForConfirmation

waitForConfirmation<T>(getInfo: ((hash: string) => Promise<T>), hash: string, timeout: number, maxRetries?: number, retryDelay?: number): Promise<T>
Waits for a transaction to be confirmed within a given timeout period. Implements a retry mechanism to handle transient errors from the getInfo function.

Returns
A promise that resolves with the transaction info if confirmed, otherwise rejects on timeout or persistent errors.

Throws
If the timeout is reached before confirmation or if getInfo fails consistently beyond the allowed retries.
Type Parameters
- T
  
  The expected return type of the transaction info.
Parameters
- getInfo: ((hash: string) => Promise<T>)
  
  A function that fetches transaction info based on its hash.
  - - (hash: string): Promise<T>
    - Parameters
      
      hash: string
      
      Returns Promise<T>
- hash: string
  
  The transaction hash to monitor.
- timeout: number
  
  The maximum time (in milliseconds) to wait for confirmation.
- maxRetries: number = 3
  
  The maximum number of retries for transient errors.
- retryDelay: number = 500
  
  The delay (in milliseconds) between retry attempts.
Returns Promise<T>
- Defined in src/rpc/rpc_client.ts:1398

waitForDeploy

waitForDeploy(deploy: Deploy, timeout?: number): Promise<InfoGetDeployResult>
Waits for a deploy to be confirmed on-chain.

Returns
A promise that resolves to InfoGetDeployResult if successful.

Throws
An error if the deploy times out.
Parameters
- deploy: Deploy
  
  The deploy instance.
- timeout: number = 60000
  
  Optional timeout in milliseconds (default: 60000ms).
Returns Promise<InfoGetDeployResult>
- Defined in src/rpc/rpc_client.ts:1461

waitForTransaction

waitForTransaction(transaction: Transaction, timeout?: number): Promise<InfoGetTransactionResult>
Waits for a transaction to be confirmed on-chain.

Returns
A promise that resolves to InfoGetTransactionResult if successful.

Throws
An error if the transaction times out.
Parameters
- transaction: Transaction
  
  The transaction instance.
- timeout: number = 6000
  
  Optional timeout in milliseconds (default: 6000ms).
Returns Promise<InfoGetTransactionResult>
- Defined in src/rpc/rpc_client.ts:1443

Class RpcClient

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

handler: IHandler

Returns RpcClient

Properties

Private handler

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>

getAuctionInfoByHash

Returns

Rpc

Parameters

blockHash: string

Returns Promise<StateGetAuctionInfoResult>

getAuctionInfoByHeight

Returns

Rpc

Parameters

height: number

Returns Promise<StateGetAuctionInfoResult>

getAuctionInfoV1ByHash

Returns

Rpc

Parameters

blockHash: string

Returns Promise<StateGetAuctionInfoV1Result>

getAuctionInfoV1ByHeight

Returns

Rpc

Parameters

height: number

Returns Promise<StateGetAuctionInfoV1Result>

getAuctionInfoV2ByHash

Parameters

blockHash: string

Returns Promise<StateGetAuctionInfoV2Result>

getAuctionInfoV2ByHeight

Parameters

height: number

Returns Promise<StateGetAuctionInfoV2Result>

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

`Private` handler