Skip to main content

StakingPoolV1

Namespace: IotaSdk

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

public class StakingPoolV1 : IStakingPoolV1, System.IDisposable

Inheritance ObjectStakingPoolV1
Implements IStakingPoolV1, IDisposable
Attributes NullableContextAttribute, NullableAttribute

Constructors

StakingPoolV1(UInt64)

public StakingPoolV1(ulong pointer)

Parameters

pointer UInt64

Methods

Destroy()

public void Destroy()

Dispose()

public void Dispose()

ActivationEpoch()

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

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

public ulong? DeactivationEpoch()

Returns

UInt64?

ExchangeRatesId()

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

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

public ulong ExchangeRatesSize()

Returns

UInt64

ExtraFieldsId()

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

public ObjectId ExtraFieldsId()

Returns

ObjectId

Id()

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

public ulong IotaBalance()

Returns

UInt64

PendingPoolTokenWithdraw()

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

public ulong PendingPoolTokenWithdraw()

Returns

UInt64

PendingStake()

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

public ulong PendingStake()

Returns

UInt64

PendingTotalIotaWithdraw()

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

public ulong PendingTotalIotaWithdraw()

Returns

UInt64

PoolTokenBalance()

Total number of pool tokens issued by the pool.

public ulong PoolTokenBalance()

Returns

UInt64

RewardsPool()

Epoch stake rewards accumulated in the pool, in nanos.

public ulong RewardsPool()

Returns

UInt64