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