Skip to main content

Class: StakingPoolV1

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

Extends​

  • UniffiAbstractObject

Implements​

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

readonly [uniffiTypeNameSymbol]: "StakingPoolV1" = "StakingPoolV1";

Methods​

activationEpoch()​

activationEpoch(): bigint | undefined;

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

Returns​

bigint | undefined

Implementation of​

StakingPoolV1Like.activationEpoch

deactivationEpoch()​

deactivationEpoch(): bigint | undefined;

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

Returns​

bigint | undefined

Implementation of​

StakingPoolV1Like.deactivationEpoch

exchangeRatesId()​

exchangeRatesId(): ObjectIdLike;

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

Returns​

ObjectIdLike

Implementation of​

StakingPoolV1Like.exchangeRatesId

exchangeRatesSize()​

exchangeRatesSize(): bigint;

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

Returns​

bigint

Implementation of​

StakingPoolV1Like.exchangeRatesSize

extraFieldsId()​

extraFieldsId(): ObjectIdLike;

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

Returns​

ObjectIdLike

Implementation of​

StakingPoolV1Like.extraFieldsId

id()​

id(): ObjectIdLike;

Returns​

ObjectIdLike

Implementation of​

StakingPoolV1Like.id

iotaBalance()​

iotaBalance(): bigint;

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

Returns​

bigint

Implementation of​

StakingPoolV1Like.iotaBalance

pendingPoolTokenWithdraw()​

pendingPoolTokenWithdraw(): bigint;

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

Returns​

bigint

Implementation of​

StakingPoolV1Like.pendingPoolTokenWithdraw

pendingStake()​

pendingStake(): bigint;

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

Returns​

bigint

Implementation of​

StakingPoolV1Like.pendingStake

pendingTotalIotaWithdraw()​

pendingTotalIotaWithdraw(): bigint;

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

Returns​

bigint

Implementation of​

StakingPoolV1Like.pendingTotalIotaWithdraw

poolTokenBalance()​

poolTokenBalance(): bigint;

Total number of pool tokens issued by the pool.

Returns​

bigint

Implementation of​

StakingPoolV1Like.poolTokenBalance

rewardsPool()​

rewardsPool(): bigint;

Epoch stake rewards accumulated in the pool, in nanos.

Returns​

bigint

Implementation of​

StakingPoolV1Like.rewardsPool

toDebugString()​

toDebugString(): string;

Returns​

string

toString()​

toString(): string;

Returns a string representation of an object.

Returns​

string

uniffiDestroy()​

uniffiDestroy(): void;

Explicitly tell Rust to destroy the native peer that backs this object.

Once this method has been called, any following method calls will throw an error.

Can be called more than once.

Returns​

void

Overrides​

UniffiAbstractObject.uniffiDestroy

uniffiUse()​

uniffiUse<T>(block): T;

A convenience method to use this object, then destroy it after its use.

Type Parameters​

T​

T

Parameters​

block​

(obj) => T

Returns​

T

Inherited from​

UniffiAbstractObject.uniffiUse

instanceOf()​

static instanceOf(obj_): obj_ is StakingPoolV1;

Parameters​

obj_​

any

Returns​

obj_ is StakingPoolV1