Interface ClientPOS

Hierarchy

ClientPOS
- IClient

Index

Methods

getAuctionInfoByHash getAuctionInfoByHeight getAuctionInfoV1ByHash getAuctionInfoV1ByHeight getEraInfoByBlockHash getEraInfoByBlockHeight getEraInfoLatest getLatestAuctionInfo getLatestAuctionInfoV1 getValidatorChangesInfo

Methods

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>
- Defined in src/rpc/client.ts:55

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>
- Defined in src/rpc/client.ts:63

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>
- Defined in src/rpc/client.ts:78

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>
- Defined in src/rpc/client.ts:88

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>
- Defined in src/rpc/client.ts:114

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>
- Defined in src/rpc/client.ts:106

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>
- Defined in src/rpc/client.ts:98

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>
- Defined in src/rpc/client.ts:47

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>
- Defined in src/rpc/client.ts:70

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>
- Defined in src/rpc/client.ts:122

Generated using TypeDoc