sui_json_rpc_api

Trait GovernanceReadApiServer

Source 
pub trait GovernanceReadApiServer:
    Sized
    + Send
    + Sync
    + 'static {
    // Required methods
    fn get_stakes_by_ids<'life0, 'async_trait>(
        &'life0 self,
        staked_sui_ids: Vec<ObjectID>,
    ) -> Pin<Box<dyn Future<Output = RpcResult<Vec<DelegatedStake>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_stakes<'life0, 'async_trait>(
        &'life0 self,
        owner: SuiAddress,
    ) -> Pin<Box<dyn Future<Output = RpcResult<Vec<DelegatedStake>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_committee_info<'life0, 'async_trait>(
        &'life0 self,
        epoch: Option<BigInt<u64>>,
    ) -> Pin<Box<dyn Future<Output = RpcResult<SuiCommittee>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_latest_sui_system_state<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = RpcResult<SuiSystemStateSummary>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_reference_gas_price<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = RpcResult<BigInt<u64>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_validators_apy<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = RpcResult<ValidatorApys>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;

    // Provided method
    fn into_rpc(self) -> RpcModule<Self> { ... }
}
Expand description

Server trait implementation for the GovernanceReadApi RPC API.

Required Methods§

Source

fn get_stakes_by_ids<'life0, 'async_trait>( &'life0 self, staked_sui_ids: Vec<ObjectID>, ) -> Pin<Box<dyn Future<Output = RpcResult<Vec<DelegatedStake>>> + Send + 'async_trait>>
where Self: '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 = RpcResult<Vec<DelegatedStake>>> + Send + 'async_trait>>
where Self: '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 = RpcResult<SuiCommittee>> + Send + 'async_trait>>
where Self: '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 = RpcResult<SuiSystemStateSummary>> + Send + 'async_trait>>
where Self: '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 = RpcResult<BigInt<u64>>> + Send + 'async_trait>>
where Self: '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 = RpcResult<ValidatorApys>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Return the validator APY

Provided Methods§

Source

fn into_rpc(self) -> RpcModule<Self>

Collects all the methods and subscriptions defined in the trait and adds them into a single RpcModule.

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§