Skip to main content

IStakingPoolV1

Namespace: IotaSdk

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

public interface IStakingPoolV1

Attributes NullableContextAttribute

Methods​

ActivationEpoch()​

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

ulong? ActivationEpoch()

Returns​

UInt64?

DeactivationEpoch()​

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

ulong? DeactivationEpoch()

Returns​

UInt64?

ExchangeRatesId()​

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

ObjectId ExchangeRatesId()

Returns​

ObjectId

ExchangeRatesSize()​

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

ulong ExchangeRatesSize()

Returns​

UInt64

ExtraFieldsId()​

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

ObjectId ExtraFieldsId()

Returns​

ObjectId

Id()​

ObjectId Id()

Returns​

ObjectId

IotaBalance()​

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

ulong IotaBalance()

Returns​

UInt64

PendingPoolTokenWithdraw()​

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

ulong PendingPoolTokenWithdraw()

Returns​

UInt64

PendingStake()​

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

ulong PendingStake()

Returns​

UInt64

PendingTotalIotaWithdraw()​

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

ulong PendingTotalIotaWithdraw()

Returns​

UInt64

PoolTokenBalance()​

Total number of pool tokens issued by the pool.

ulong PoolTokenBalance()

Returns​

UInt64

RewardsPool()​

Epoch stake rewards accumulated in the pool, in nanos.

ulong RewardsPool()

Returns​

UInt64