Struct StakingPool

#[non_exhaustive]
pub struct StakingPool {
    pub id: Option<String>,
    pub activation_epoch: Option<u64>,
    pub deactivation_epoch: Option<u64>,
    pub sui_balance: Option<u64>,
    pub rewards_pool: Option<u64>,
    pub pool_token_balance: Option<u64>,
    pub exchange_rates: Option<MoveTable>,
    pub pending_stake: Option<u64>,
    pub pending_total_sui_withdraw: Option<u64>,
    pub pending_pool_token_withdraw: Option<u64>,
    pub extra_fields: Option<MoveTable>,
}

A staking pool embedded in each validator struct in the system state object.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

UID of the StakingPool object

activation_epoch: Option<u64>

The epoch at which this pool became active. The value is None if the pool is pre-active and Some(<epoch_number>) if active or inactive.

deactivation_epoch: Option<u64>

The epoch at which this staking pool ceased to be active. None = {pre-active, active}, Some(<epoch_number>) if in-active, and it was de-activated at epoch <epoch_number>.

sui_balance: Option<u64>

The total number of SUI tokens in this pool, including the SUI in the rewards_pool, as well as in all the principal in the StakedSui object, updated at epoch boundaries.

rewards_pool: Option<u64>

The epoch stake rewards will be added here at the end of each epoch.

pool_token_balance: Option<u64>

Total number of pool tokens issued by the pool.

exchange_rates: Option<MoveTable>

Exchange rate history of previous epochs.

The entries start from the activation_epoch of this pool and contains exchange rates at the beginning of each epoch, i.e., right after the rewards for the previous epoch have been deposited into the pool.

key: u64 (epoch number), value: PoolTokenExchangeRate

pending_stake: Option<u64>

Pending stake amount for this epoch, emptied at epoch boundaries.

pending_total_sui_withdraw: Option<u64>

Pending stake withdrawn during the current epoch, emptied at epoch boundaries. This includes both the principal and rewards SUI withdrawn.

pending_pool_token_withdraw: Option<u64>

Pending pool token withdrawn during the current epoch, emptied at epoch boundaries.

extra_fields: Option<MoveTable>

Any extra fields that’s not defined statically.

Implementations

impl StakingPool

pub const ID_FIELD: &'static MessageField

pub const ACTIVATION_EPOCH_FIELD: &'static MessageField

pub const DEACTIVATION_EPOCH_FIELD: &'static MessageField

pub const SUI_BALANCE_FIELD: &'static MessageField

pub const REWARDS_POOL_FIELD: &'static MessageField

pub const POOL_TOKEN_BALANCE_FIELD: &'static MessageField

pub const EXCHANGE_RATES_FIELD: &'static MessageField

pub const PENDING_STAKE_FIELD: &'static MessageField

pub const PENDING_TOTAL_SUI_WITHDRAW_FIELD: &'static MessageField

pub const PENDING_POOL_TOKEN_WITHDRAW_FIELD: &'static MessageField

pub const EXTRA_FIELDS_FIELD: &'static MessageField

impl StakingPool

pub fn path_builder() -> StakingPoolFieldPathBuilder

impl StakingPool

pub const fn const_default() -> Self

pub fn id_opt_mut(&mut self) -> Option<&mut String>

If id is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn id_mut(&mut self) -> &mut String

Returns a mutable reference to id. If the field is unset, it is first initialized with the default value.

pub fn id_opt(&self) -> Option<&str>

If id is set, returns Some with the value; otherwise returns None.

pub fn set_id<T: Into<String>>(&mut self, field: T)

Sets id with the provided value.

pub fn with_id<T: Into<String>>(self, field: T) -> Self

Sets id with the provided value.

pub fn activation_epoch_opt_mut(&mut self) -> Option<&mut u64>

If activation_epoch is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn activation_epoch_mut(&mut self) -> &mut u64

Returns a mutable reference to activation_epoch. If the field is unset, it is first initialized with the default value.

pub fn activation_epoch_opt(&self) -> Option<u64>

If activation_epoch is set, returns Some with the value; otherwise returns None.

pub fn set_activation_epoch<T: Into<u64>>(&mut self, field: T)

Sets activation_epoch with the provided value.

pub fn with_activation_epoch<T: Into<u64>>(self, field: T) -> Self

Sets activation_epoch with the provided value.

pub fn deactivation_epoch_opt_mut(&mut self) -> Option<&mut u64>

If deactivation_epoch is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn deactivation_epoch_mut(&mut self) -> &mut u64

Returns a mutable reference to deactivation_epoch. If the field is unset, it is first initialized with the default value.

pub fn deactivation_epoch_opt(&self) -> Option<u64>

If deactivation_epoch is set, returns Some with the value; otherwise returns None.

pub fn set_deactivation_epoch<T: Into<u64>>(&mut self, field: T)

Sets deactivation_epoch with the provided value.

pub fn with_deactivation_epoch<T: Into<u64>>(self, field: T) -> Self

Sets deactivation_epoch with the provided value.

pub fn sui_balance_opt_mut(&mut self) -> Option<&mut u64>

If sui_balance is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn sui_balance_mut(&mut self) -> &mut u64

Returns a mutable reference to sui_balance. If the field is unset, it is first initialized with the default value.

pub fn sui_balance_opt(&self) -> Option<u64>

If sui_balance is set, returns Some with the value; otherwise returns None.

pub fn set_sui_balance<T: Into<u64>>(&mut self, field: T)

Sets sui_balance with the provided value.

pub fn with_sui_balance<T: Into<u64>>(self, field: T) -> Self

Sets sui_balance with the provided value.

pub fn rewards_pool_opt_mut(&mut self) -> Option<&mut u64>

If rewards_pool is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn rewards_pool_mut(&mut self) -> &mut u64

Returns a mutable reference to rewards_pool. If the field is unset, it is first initialized with the default value.

pub fn rewards_pool_opt(&self) -> Option<u64>

If rewards_pool is set, returns Some with the value; otherwise returns None.

pub fn set_rewards_pool<T: Into<u64>>(&mut self, field: T)

Sets rewards_pool with the provided value.

pub fn with_rewards_pool<T: Into<u64>>(self, field: T) -> Self

Sets rewards_pool with the provided value.

pub fn pool_token_balance_opt_mut(&mut self) -> Option<&mut u64>

If pool_token_balance is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn pool_token_balance_mut(&mut self) -> &mut u64

Returns a mutable reference to pool_token_balance. If the field is unset, it is first initialized with the default value.

pub fn pool_token_balance_opt(&self) -> Option<u64>

If pool_token_balance is set, returns Some with the value; otherwise returns None.

pub fn set_pool_token_balance<T: Into<u64>>(&mut self, field: T)

Sets pool_token_balance with the provided value.

pub fn with_pool_token_balance<T: Into<u64>>(self, field: T) -> Self

Sets pool_token_balance with the provided value.

pub fn exchange_rates(&self) -> &MoveTable

Returns the value of exchange_rates, or the default value if exchange_rates is unset.

pub fn exchange_rates_opt_mut(&mut self) -> Option<&mut MoveTable>

If exchange_rates is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn exchange_rates_mut(&mut self) -> &mut MoveTable

Returns a mutable reference to exchange_rates. If the field is unset, it is first initialized with the default value.

pub fn exchange_rates_opt(&self) -> Option<&MoveTable>

If exchange_rates is set, returns Some with the value; otherwise returns None.

pub fn set_exchange_rates<T: Into<MoveTable>>(&mut self, field: T)

Sets exchange_rates with the provided value.

pub fn with_exchange_rates<T: Into<MoveTable>>(self, field: T) -> Self

Sets exchange_rates with the provided value.

pub fn pending_stake_opt_mut(&mut self) -> Option<&mut u64>

If pending_stake is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn pending_stake_mut(&mut self) -> &mut u64

Returns a mutable reference to pending_stake. If the field is unset, it is first initialized with the default value.

pub fn pending_stake_opt(&self) -> Option<u64>

If pending_stake is set, returns Some with the value; otherwise returns None.

pub fn set_pending_stake<T: Into<u64>>(&mut self, field: T)

Sets pending_stake with the provided value.

pub fn with_pending_stake<T: Into<u64>>(self, field: T) -> Self

Sets pending_stake with the provided value.

pub fn pending_total_sui_withdraw_opt_mut(&mut self) -> Option<&mut u64>

If pending_total_sui_withdraw is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn pending_total_sui_withdraw_mut(&mut self) -> &mut u64

Returns a mutable reference to pending_total_sui_withdraw. If the field is unset, it is first initialized with the default value.

pub fn pending_total_sui_withdraw_opt(&self) -> Option<u64>

If pending_total_sui_withdraw is set, returns Some with the value; otherwise returns None.

pub fn set_pending_total_sui_withdraw<T: Into<u64>>(&mut self, field: T)

Sets pending_total_sui_withdraw with the provided value.

pub fn with_pending_total_sui_withdraw<T: Into<u64>>(self, field: T) -> Self

Sets pending_total_sui_withdraw with the provided value.

pub fn pending_pool_token_withdraw_opt_mut(&mut self) -> Option<&mut u64>

If pending_pool_token_withdraw is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn pending_pool_token_withdraw_mut(&mut self) -> &mut u64

Returns a mutable reference to pending_pool_token_withdraw. If the field is unset, it is first initialized with the default value.

pub fn pending_pool_token_withdraw_opt(&self) -> Option<u64>

If pending_pool_token_withdraw is set, returns Some with the value; otherwise returns None.

pub fn set_pending_pool_token_withdraw<T: Into<u64>>(&mut self, field: T)

Sets pending_pool_token_withdraw with the provided value.

pub fn with_pending_pool_token_withdraw<T: Into<u64>>(self, field: T) -> Self

Sets pending_pool_token_withdraw with the provided value.

pub fn extra_fields(&self) -> &MoveTable

Returns the value of extra_fields, or the default value if extra_fields is unset.

pub fn extra_fields_opt_mut(&mut self) -> Option<&mut MoveTable>

If extra_fields is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn extra_fields_mut(&mut self) -> &mut MoveTable

Returns a mutable reference to extra_fields. If the field is unset, it is first initialized with the default value.

pub fn extra_fields_opt(&self) -> Option<&MoveTable>

If extra_fields is set, returns Some with the value; otherwise returns None.

pub fn set_extra_fields<T: Into<MoveTable>>(&mut self, field: T)

Sets extra_fields with the provided value.

pub fn with_extra_fields<T: Into<MoveTable>>(self, field: T) -> Self

Sets extra_fields with the provided value.

impl StakingPool

pub fn id(&self) -> &str

Returns the value of id, or the default value if id is unset.

pub fn activation_epoch(&self) -> u64

Returns the value of activation_epoch, or the default value if activation_epoch is unset.

pub fn deactivation_epoch(&self) -> u64

Returns the value of deactivation_epoch, or the default value if deactivation_epoch is unset.

pub fn sui_balance(&self) -> u64

Returns the value of sui_balance, or the default value if sui_balance is unset.

pub fn rewards_pool(&self) -> u64

Returns the value of rewards_pool, or the default value if rewards_pool is unset.

pub fn pool_token_balance(&self) -> u64

Returns the value of pool_token_balance, or the default value if pool_token_balance is unset.

pub fn pending_stake(&self) -> u64

Returns the value of pending_stake, or the default value if pending_stake is unset.

pub fn pending_total_sui_withdraw(&self) -> u64

Returns the value of pending_total_sui_withdraw, or the default value if pending_total_sui_withdraw is unset.

pub fn pending_pool_token_withdraw(&self) -> u64

Returns the value of pending_pool_token_withdraw, or the default value if pending_pool_token_withdraw is unset.

Trait Implementations

impl Clone for StakingPool

fn clone(&self) -> StakingPool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StakingPool

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

Formats the value using the given formatter.

impl Default for StakingPool

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StakingPool

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for StakingPool

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for StakingPool

const FIELDS: &'static [&'static MessageField]

impl PartialEq for StakingPool

fn eq(&self, other: &StakingPool) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StakingPool

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StakingPool