Skip to main content

Type Alias: Validator

type Validator = {
  address: AddressLike;
  apy?: number;
  commissionRate?: number;
  credentials?: ValidatorCredentials;
  description?: string;
  exchangeRatesSize?: bigint;
  gasPrice?: bigint;
  imageUrl?: string;
  name?: string;
  nextEpochCommissionRate?: number;
  nextEpochCredentials?: ValidatorCredentials;
  nextEpochGasPrice?: bigint;
  nextEpochStake?: bigint;
  operationCap?: ArrayBuffer;
  pendingPoolTokenWithdraw?: bigint;
  pendingStake?: bigint;
  pendingTotalIotaWithdraw?: bigint;
  poolTokenBalance?: bigint;
  projectUrl?: string;
  rewardsPool?: bigint;
  stakingPoolActivationEpoch?: bigint;
  stakingPoolId: ObjectIdLike;
  stakingPoolIotaBalance?: bigint;
  votingPower?: number;
};

Represents a validator in the system.

Properties​

address​

address: AddressLike;

The validator's address.

apy?​

optional apy?: number;

The APY of this validator in basis points. To get the APY in percentage, divide by 100.

commissionRate?​

optional commissionRate?: number;

The fee charged by the validator for staking services.

credentials?​

optional credentials?: ValidatorCredentials;

Validator's credentials.

description?​

optional description?: string;

Validator's description.

exchangeRatesSize?​

optional exchangeRatesSize?: bigint;

Number of exchange rates in the table.

gasPrice?​

optional gasPrice?: bigint;

The reference gas price for this epoch.

imageUrl?​

optional imageUrl?: string;

Validator's url containing their custom image.

name?​

optional name?: string;

Validator's name.

nextEpochCommissionRate?​

optional nextEpochCommissionRate?: number;

The proposed next epoch fee for the validator's staking services.

nextEpochCredentials?​

optional nextEpochCredentials?: ValidatorCredentials;

Validator's credentials for the next epoch.

nextEpochGasPrice?​

optional nextEpochGasPrice?: bigint;

The validator's gas price quote for the next epoch.

nextEpochStake?​

optional nextEpochStake?: bigint;

The total number of IOTA tokens in this pool plus the pending stake amount for this epoch.

operationCap?​

optional operationCap?: ArrayBuffer;

The validator's current valid Cap object. Validators can delegate the operation ability to another address. The address holding this Cap object can then update the reference gas price and tallying rule on behalf of the validator.

pendingPoolTokenWithdraw?​

optional pendingPoolTokenWithdraw?: bigint;

Pending pool token withdrawn during the current epoch, emptied at epoch boundaries. Zero for past epochs.

pendingStake?​

optional pendingStake?: bigint;

Pending stake amount for the current epoch, emptied at epoch boundaries. Zero for past epochs.

pendingTotalIotaWithdraw?​

optional pendingTotalIotaWithdraw?: bigint;

Pending stake withdrawn during the current epoch, emptied at epoch boundaries. Zero for past epochs.

poolTokenBalance?​

optional poolTokenBalance?: bigint;

Total number of pool tokens issued by the pool.

projectUrl?​

optional projectUrl?: string;

Validator's homepage URL.

rewardsPool?​

optional rewardsPool?: bigint;

The epoch stake rewards will be added here at the end of each epoch.

stakingPoolActivationEpoch?​

optional stakingPoolActivationEpoch?: bigint;

The epoch at which this pool became active.

stakingPoolId​

stakingPoolId: ObjectIdLike;

The ID of this validator's 0x3::staking_pool::StakingPool.

stakingPoolIotaBalance?​

optional stakingPoolIotaBalance?: bigint;

The total number of IOTA tokens in this pool.

votingPower?​

optional votingPower?: number;

The voting power of this validator in basis points (e.g., 100 = 1% voting power).