StakingPoolV1Interface
interface StakingPoolV1Interface
A typed view of a 0x3::staking_pool::StakingPoolV1 embedded in a validator.
Inheritors
| StakingPoolV1 |
Functions
| Name | Summary |
|---|---|
| activationEpoch | abstract fun activationEpoch(): ULong? The epoch at which this pool became active. None while pre-active; Some(epoch) once active or inactive. |
| deactivationEpoch | abstract fun deactivationEpoch(): ULong? The epoch at which this pool ceased to be active. None while pre-active or active; Some(epoch) once inactive. |
| exchangeRatesId | abstract fun exchangeRatesId(): ObjectId Object ID of the Table holding the exchange-rate history, keyed by epoch. |
| exchangeRatesSize | abstract fun exchangeRatesSize(): ULong Number of exchange-rate history entries. The entries themselves are stored in dynamic fields and are not part of this struct's contents. |
| extraFieldsId | abstract fun extraFieldsId(): ObjectId Object ID of the Bag holding fields added to this struct after its current on-chain layout was set. |
| id | abstract fun id(): ObjectId |
| iotaBalance | abstract fun iotaBalance(): ULong The total number of IOTA tokens in this pool, including the rewards and the principal of every StakedIota, in nanos; updated at epoch boundaries. |
| pendingPoolTokenWithdraw | abstract fun pendingPoolTokenWithdraw(): ULong Pending pool tokens withdrawn during the current epoch, emptied at epoch boundaries. |
| pendingStake | abstract fun pendingStake(): ULong Pending stake amount for this epoch, emptied at epoch boundaries. |
| pendingTotalIotaWithdraw | abstract fun pendingTotalIotaWithdraw(): ULong Pending stake withdrawn during the current epoch, including both principal and rewards; emptied at epoch boundaries. |
| poolTokenBalance | abstract fun poolTokenBalance(): ULong Total number of pool tokens issued by the pool. |
| rewardsPool | abstract fun rewardsPool(): ULong Epoch stake rewards accumulated in the pool, in nanos. |