Skip to main content

Validator

Validator​

struct Validator

Represents a validator in the system.

init(apy:address:commissionRate:credentials:description:exchangeRatesSize:gasPrice:name:imageUrl:nextEpochCommissionRate:nextEpochCredentials:nextEpochGasPrice:nextEpochStake:operationCap:pendingPoolTokenWithdraw:pendingStake:pendingTotalIotaWithdraw:poolTokenBalance:projectUrl:rewardsPool:stakingPoolActivationEpoch:stakingPoolId:stakingPoolIotaBalance:votingPower:)​

init(apy: Int32? = nil, address: Address, commissionRate: Int32? = nil, credentials: ValidatorCredentials? = nil, description: String? = nil, exchangeRatesSize: UInt64? = nil, gasPrice: UInt64? = nil, name: String? = nil, imageUrl: String? = nil, nextEpochCommissionRate: Int32? = nil, nextEpochCredentials: ValidatorCredentials? = nil, nextEpochGasPrice: UInt64? = nil, nextEpochStake: UInt64? = nil, operationCap: Data? = nil, pendingPoolTokenWithdraw: UInt64? = nil, pendingStake: UInt64? = nil, pendingTotalIotaWithdraw: UInt64? = nil, poolTokenBalance: UInt64? = nil, projectUrl: String? = nil, rewardsPool: UInt64? = nil, stakingPoolActivationEpoch: UInt64? = nil, stakingPoolId: ObjectId, stakingPoolIotaBalance: UInt64? = nil, votingPower: Int32? = nil)

address​

var address: Address

The validator's address.

apy​

var apy: Int32?

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

commissionRate​

var commissionRate: Int32?

The fee charged by the validator for staking services.

credentials​

var credentials: ValidatorCredentials?

Validator's credentials.

description​

var description: String?

Validator's description.

exchangeRatesSize​

var exchangeRatesSize: UInt64?

Number of exchange rates in the table.

gasPrice​

var gasPrice: UInt64?

The reference gas price for this epoch.

imageUrl​

var imageUrl: String?

Validator's url containing their custom image.

name​

var name: String?

Validator's name.

nextEpochCommissionRate​

var nextEpochCommissionRate: Int32?

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

nextEpochCredentials​

var nextEpochCredentials: ValidatorCredentials?

Validator's credentials for the next epoch.

nextEpochGasPrice​

var nextEpochGasPrice: UInt64?

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

nextEpochStake​

var nextEpochStake: UInt64?

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

operationCap​

var operationCap: Data?

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​

var pendingPoolTokenWithdraw: UInt64?

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

pendingStake​

var pendingStake: UInt64?

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

pendingTotalIotaWithdraw​

var pendingTotalIotaWithdraw: UInt64?

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

poolTokenBalance​

var poolTokenBalance: UInt64?

Total number of pool tokens issued by the pool.

projectUrl​

var projectUrl: String?

Validator's homepage URL.

rewardsPool​

var rewardsPool: UInt64?

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

stakingPoolActivationEpoch​

var stakingPoolActivationEpoch: UInt64?

The epoch at which this pool became active.

stakingPoolId​

var stakingPoolId: ObjectId

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

stakingPoolIotaBalance​

var stakingPoolIotaBalance: UInt64?

The total number of IOTA tokens in this pool.

votingPower​

var votingPower: Int32?

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