sui_json_rpc_api

Trait GovernanceReadApiClient

Source
pub trait GovernanceReadApiClient: ClientT {
    // Provided methods
    fn get_stakes_by_ids<'life0, 'async_trait>(
        &'life0 self,
        staked_sui_ids: Vec<ObjectID>,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<DelegatedStake>, Error>> + Send + 'async_trait>>
       where Self: Sync + 'async_trait,
             'life0: 'async_trait { ... }
    fn get_stakes<'life0, 'async_trait>(
        &'life0 self,
        owner: SuiAddress,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<DelegatedStake>, Error>> + Send + 'async_trait>>
       where Self: Sync + 'async_trait,
             'life0: 'async_trait { ... }
    fn get_committee_info<'life0, 'async_trait>(
        &'life0 self,
        epoch: Option<BigInt<u64>>,
    ) -> Pin<Box<dyn Future<Output = Result<SuiCommittee, Error>> + Send + 'async_trait>>
       where Self: Sync + 'async_trait,
             'life0: 'async_trait { ... }
    fn get_latest_sui_system_state<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<SuiSystemStateSummary, Error>> + Send + 'async_trait>>
       where Self: Sync + 'async_trait,
             'life0: 'async_trait { ... }
    fn get_reference_gas_price<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<BigInt<u64>, Error>> + Send + 'async_trait>>
       where Self: Sync + 'async_trait,
             'life0: 'async_trait { ... }
    fn get_validators_apy<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<ValidatorApys, Error>> + Send + 'async_trait>>
       where Self: Sync + 'async_trait,
             'life0: 'async_trait { ... }
}
Expand description

Client implementation for the GovernanceReadApi RPC API.

Provided Methods§

Source

fn get_stakes_by_ids<'life0, 'async_trait>( &'life0 self, staked_sui_ids: Vec<ObjectID>, ) -> Pin<Box<dyn Future<Output = Result<Vec<DelegatedStake>, Error>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Return one or more [DelegatedStake]. If a Stake was withdrawn its status will be Unstaked.

Source

fn get_stakes<'life0, 'async_trait>( &'life0 self, owner: SuiAddress, ) -> Pin<Box<dyn Future<Output = Result<Vec<DelegatedStake>, Error>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Return all [DelegatedStake].

Source

fn get_committee_info<'life0, 'async_trait>( &'life0 self, epoch: Option<BigInt<u64>>, ) -> Pin<Box<dyn Future<Output = Result<SuiCommittee, Error>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Return the committee information for the asked epoch.

Source

fn get_latest_sui_system_state<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<SuiSystemStateSummary, Error>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Return the latest SUI system state object on-chain.

Source

fn get_reference_gas_price<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<BigInt<u64>, Error>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Return the reference gas price for the network

Source

fn get_validators_apy<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ValidatorApys, Error>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Return the validator APY

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§

Source§

impl<TypeJsonRpseeInteral> GovernanceReadApiClient for TypeJsonRpseeInteral
where TypeJsonRpseeInteral: ClientT,