Struct sui_sdk::apis::GovernanceApi

pub struct GovernanceApi { /* private fields */ }

Governance API provides the staking functionality.

Implementations

impl GovernanceApi

pub async fn get_stakes( &self, owner: SuiAddress, ) -> SuiRpcResult<Vec<DelegatedStake>>

Return a list of [DelegatedStake] objects for the given address, or an error upon failure.

pub async fn get_committee_info( &self, epoch: Option<BigInt<u64>>, ) -> SuiRpcResult<SuiCommittee>

Return the [SuiCommittee] information for the given epoch, or an error upon failure.

The argument epoch is the known epoch id or None for the current epoch.

Examples

use sui_sdk::SuiClientBuilder;

#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
    let sui = SuiClientBuilder::default().build_localnet().await?;
    let committee_info = sui
        .governance_api()
        .get_committee_info(None)
        .await?;
    Ok(())
}

pub async fn get_latest_sui_system_state( &self, ) -> SuiRpcResult<SuiSystemStateSummary>

Return the latest SUI system state object on-chain, or an error upon failure.

Use this method to access system’s information, such as the current epoch, the protocol version, the reference gas price, the total stake, active validators, and much more. See the [SuiSystemStateSummary] for all the available fields.

pub async fn get_reference_gas_price(&self) -> SuiRpcResult<u64>

Return the reference gas price for the network, or an error upon failure.

Trait Implementations

impl Clone for GovernanceApi

fn clone(&self) -> GovernanceApi

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GovernanceApi

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.