Ksui/xyz.mcxross.ksui.protocol/General

General

interface General

Defines the general-purpose API for querying chain-wide information.

This interface provides methods to fetch data about checkpoints, epochs, gas prices, and the overall system state of the Sui network.

Inheritors

Properties

Link copied to clipboard
abstract val config: <Error class: unknown class>

The SuiConfig object specifying the RPC endpoint and connection settings.

Functions

Link copied to clipboard
abstract suspend fun getChainIdentifier(): <Error class: unknown class><GetChainIdentifierQuery.Data?, <Error class: unknown class>>

Fetches the first 4 bytes of the chain's genesis checkpoint digest.

Link copied to clipboard
abstract suspend fun getCheckpoint(checkpointId: <Error class: unknown class>? = CheckpointId()): <Error class: unknown class><GetCheckpointQuery.Data?, <Error class: unknown class>>

Fetches the details of a specific checkpoint.

Link copied to clipboard
abstract suspend fun getCheckpoints(first: Int?, before: String?, last: Int?, after: String?): <Error class: unknown class><GetCheckpointsQuery.Data?, <Error class: unknown class>>

Fetches a paginated list of checkpoints.

Link copied to clipboard
abstract suspend fun getCurrentEpoch(): <Error class: unknown class><GetCurrentEpochQuery.Data?, <Error class: unknown class>>

Fetches details about the current epoch.

Link copied to clipboard
abstract suspend fun getLatestCheckpointSequenceNumber(): <Error class: unknown class><GetLatestCheckpointSequenceNumberQuery.Data?, <Error class: unknown class>>

Fetches the sequence number of the most recently processed checkpoint.

Link copied to clipboard
abstract suspend fun getLatestSuiSystemState(): <Error class: unknown class><GetLatestSuiSystemStateQuery.Data?, <Error class: unknown class>>

Fetches the most recent SuiSystemState object.

Link copied to clipboard
abstract suspend fun getProtocolConfig(protocolVersion: Int? = null): <Error class: unknown class><GetProtocolConfigQuery.Data?, <Error class: unknown class>>

Fetches the protocol configuration for a specific version.

Link copied to clipboard
abstract suspend fun getReferenceGasPrice(): <Error class: unknown class><GetReferenceGasPriceQuery.Data?, <Error class: unknown class>>

Fetches the current reference gas price for the network.

Link copied to clipboard
abstract suspend fun paginateCheckpointTransactionBlocks(id: <Error class: unknown class>? = null, after: String? = null): <Error class: unknown class><PaginateCheckpointTransactionBlocksQuery.Data?, <Error class: unknown class>>

Fetches a paginated list of transaction blocks for a given checkpoint.

Link copied to clipboard
abstract suspend fun paginateEpochValidators(id: Long, after: String? = null): <Error class: unknown class><PaginateEpochValidatorsQuery.Data?, <Error class: unknown class>>

Fetches a paginated list of validators for a specific epoch.

Link copied to clipboard
inline suspend fun <T> General.query(query: <Error class: unknown class>): Nothing