Skip to main content

StakingPoolV1

type StakingPoolV1​

A typed view of a `0x3::staking_pool::StakingPoolV1` embedded in a validator.

type StakingPoolV1 struct {
    // contains filtered or unexported fields
}

func LiftFromExternalStakingPoolV1​

func LiftFromExternalStakingPoolV1(handle uint64) *StakingPoolV1

func (*StakingPoolV1) ActivationEpoch​

func (_self *StakingPoolV1) ActivationEpoch() *uint64

The epoch at which this pool became active. `None` while pre-active; `Some(epoch)` once active or inactive.

func (*StakingPoolV1) DeactivationEpoch​

func (_self *StakingPoolV1) DeactivationEpoch() *uint64

The epoch at which this pool ceased to be active. `None` while pre-active or active; `Some(epoch)` once inactive.

func (*StakingPoolV1) DebugString​

func (_self *StakingPoolV1) DebugString() string

func (*StakingPoolV1) Destroy​

func (object *StakingPoolV1) Destroy()

func (*StakingPoolV1) ExchangeRatesId​

func (_self *StakingPoolV1) ExchangeRatesId() *ObjectId

Object ID of the `Table` holding the exchange-rate history, keyed by epoch.

func (*StakingPoolV1) ExchangeRatesSize​

func (_self *StakingPoolV1) ExchangeRatesSize() uint64

Number of exchange-rate history entries. The entries themselves are stored in dynamic fields and are not part of this struct's contents.

func (*StakingPoolV1) ExtraFieldsId​

func (_self *StakingPoolV1) ExtraFieldsId() *ObjectId

Object ID of the `Bag` holding fields added to this struct after its current on-chain layout was set.

func (*StakingPoolV1) Id​

func (_self *StakingPoolV1) Id() *ObjectId

func (*StakingPoolV1) IotaBalance​

func (_self *StakingPoolV1) IotaBalance() uint64

The total number of IOTA tokens in this pool, including the rewards and the principal of every `StakedIota`, in nanos; updated at epoch boundaries.

func (*StakingPoolV1) PendingPoolTokenWithdraw​

func (_self *StakingPoolV1) PendingPoolTokenWithdraw() uint64

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

func (*StakingPoolV1) PendingStake​

func (_self *StakingPoolV1) PendingStake() uint64

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

func (*StakingPoolV1) PendingTotalIotaWithdraw​

func (_self *StakingPoolV1) PendingTotalIotaWithdraw() uint64

Pending stake withdrawn during the current epoch, including both principal and rewards; emptied at epoch boundaries.

func (*StakingPoolV1) PoolTokenBalance​

func (_self *StakingPoolV1) PoolTokenBalance() uint64

Total number of pool tokens issued by the pool.

func (*StakingPoolV1) RewardsPool​

func (_self *StakingPoolV1) RewardsPool() uint64

Epoch stake rewards accumulated in the pool, in nanos.