Skip to main content

Class: ValidatorSetV1

A typed view of the 0x3::validator_set::ValidatorSetV1 embedded in [IotaSystemStateV1].

Unlike [ValidatorSetV2] there are no committee members: in this layout every active validator is part of the committee.

Extends​

  • UniffiAbstractObject

Implements​

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

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

Methods​

activeValidators()​

activeValidators(): ValidatorV1Like[];

The current list of active validators.

Returns​

ValidatorV1Like[]

Implementation of​

ValidatorSetV1Like.activeValidators


atRiskValidators()​

atRiskValidators(): Map<AddressLike, bigint>;

Number of epochs each at-risk validator has had stake below the low-stake threshold.

Returns​

Map<AddressLike, bigint>

Implementation of​

ValidatorSetV1Like.atRiskValidators


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​

ValidatorSetV1Like.extraFieldsId


inactiveValidatorsId()​

inactiveValidatorsId(): ObjectIdLike;

Object ID of the Table holding the inactive validators, keyed by staking pool ID.

Returns​

ObjectIdLike

Implementation of​

ValidatorSetV1Like.inactiveValidatorsId


pendingActiveValidatorsId()​

pendingActiveValidatorsId(): ObjectIdLike;

Object ID of the TableVec holding the pending validator candidates, keyed by their index.

Returns​

ObjectIdLike

Implementation of​

ValidatorSetV1Like.pendingActiveValidatorsId


pendingActiveValidatorsSize()​

pendingActiveValidatorsSize(): bigint;

Number of pending validator candidates. The candidates themselves are stored in dynamic fields and are not part of this struct's contents.

Returns​

bigint

Implementation of​

ValidatorSetV1Like.pendingActiveValidatorsSize


pendingRemovals()​

pendingRemovals(): bigint[];

Indices into active_validators with pending removal requests.

Returns​

bigint[]

Implementation of​

ValidatorSetV1Like.pendingRemovals


stakingPoolMappingsId()​

stakingPoolMappingsId(): ObjectIdLike;

Object ID of the Table mapping each staking pool ID to its validator address.

Returns​

ObjectIdLike

Implementation of​

ValidatorSetV1Like.stakingPoolMappingsId


toDebugString()​

toDebugString(): string;

Returns​

string


toString()​

toString(): string;

Returns a string representation of an object.

Returns​

string


totalStake()​

totalStake(): bigint;

Total stake from all active validators at the beginning of the epoch, in nanos.

Returns​

bigint

Implementation of​

ValidatorSetV1Like.totalStake


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

validatorCandidatesId()​

validatorCandidatesId(): ObjectIdLike;

Object ID of the Table holding the validator candidates, keyed by their address.

Returns​

ObjectIdLike

Implementation of​

ValidatorSetV1Like.validatorCandidatesId


instanceOf()​

static instanceOf(obj_): obj_ is ValidatorSetV1;

Parameters​

obj_​

any

Returns​

obj_ is ValidatorSetV1