StakingPool

interface StakingPool

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

Properties

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

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.

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

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>.

Link copied to clipboard
abstract val exchangeRates: MoveTable

Exchange rate history of previous epochs.

Link copied to clipboard
abstract val extraFields: MoveTable

Any extra fields that's not defined statically.

Link copied to clipboard
abstract val id: String?

UID of the StakingPool object

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

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

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

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

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

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

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

Total number of pool tokens issued by the pool.

Link copied to clipboard

Returns the field-presence view for this StakingPool instance.

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

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

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

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.

Functions

Link copied to clipboard
Link copied to clipboard
fun StakingPool.copy(body: <Error class: unknown class>.() -> Unit = {}): StakingPool

Copies the original message, including unknown fields.