Skip to main content

StakingPoolV1Protocol

StakingPoolV1Protocol Objects​

class StakingPoolV1Protocol(typing.Protocol)

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

activation_epoch​

def activation_epoch() -> typing.Optional[int]

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

deactivation_epoch​

def deactivation_epoch() -> typing.Optional[int]

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

exchange_rates_id​

def exchange_rates_id() -> ObjectId

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

exchange_rates_size​

def exchange_rates_size() -> int

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

extra_fields_id​

def extra_fields_id() -> ObjectId

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

iota_balance​

def iota_balance() -> int

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

pending_pool_token_withdraw​

def pending_pool_token_withdraw() -> int

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

pending_stake​

def pending_stake() -> int

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

pending_total_iota_withdraw​

def pending_total_iota_withdraw() -> int

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

pool_token_balance​

def pool_token_balance() -> int

Total number of pool tokens issued by the pool.

rewards_pool​

def rewards_pool() -> int

Epoch stake rewards accumulated in the pool, in nanos.