Skip to main content

StakingPoolV1

StakingPoolV1​

class StakingPoolV1

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

debugDescription​

var debugDescription: String { get }

A textual representation of this instance, suitable for debugging.

Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the String(reflecting:) initializer. This initializer works with any type, and uses the custom debugDescription property for types that conform to CustomDebugStringConvertible:

struct Point: CustomDebugStringConvertible {
    let x: Int, y: Int

    var debugDescription: String {
        return "(\(x), \(y))"
    }
}

let p = Point(x: 21, y: 30)
let s = String(reflecting: p)
print(s)
// Prints "(21, 30)"

The conversion of p to a string in the assignment to s uses the Point type's debugDescription property.

activationEpoch()​

func activationEpoch() -> UInt64?

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

deactivationEpoch()​

func deactivationEpoch() -> UInt64?

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

exchangeRatesId()​

func exchangeRatesId() -> ObjectId

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

exchangeRatesSize()​

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

extraFieldsId()​

func extraFieldsId() -> ObjectId

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

id()​

func id() -> ObjectId

iotaBalance()​

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

pendingPoolTokenWithdraw()​

func pendingPoolTokenWithdraw() -> UInt64

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

pendingStake()​

func pendingStake() -> UInt64

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

pendingTotalIotaWithdraw()​

func pendingTotalIotaWithdraw() -> UInt64

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

poolTokenBalance()​

func poolTokenBalance() -> UInt64

Total number of pool tokens issued by the pool.

rewardsPool()​

func rewardsPool() -> UInt64

Epoch stake rewards accumulated in the pool, in nanos.