Skip to main content

Validator

Namespace: IotaSdk

Represents a validator in the system.

public record class Validator : System.IDisposable, System.IEquatable`1[[IotaSdk.Validator, IotaSdk, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Inheritance Object → Validator
Implements IDisposable, IEquatable<Validator>
Attributes NullableContextAttribute, NullableAttribute

Remarks:

UniFFI Warning: Optional parameters have been reordered because of a C# syntax limitation. Use named parameters for compatibility with future ordering changes.

Properties​

Address​

The validator's address.

public Address Address { get; init; }

Property Value​

Address

StakingPoolId​

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

public ObjectId StakingPoolId { get; init; }

Property Value​

ObjectId

Apy​

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

public int? Apy { get; init; }

Property Value​

Int32?

CommissionRate​

The fee charged by the validator for staking services.

public int? CommissionRate { get; init; }

Property Value​

Int32?

Credentials​

Validator's credentials.

public ValidatorCredentials? Credentials { get; init; }

Property Value​

ValidatorCredentials

Description​

Validator's description.

public string? Description { get; init; }

Property Value​

String

ExchangeRatesSize​

Number of exchange rates in the table.

public ulong? ExchangeRatesSize { get; init; }

Property Value​

UInt64?

GasPrice​

The reference gas price for this epoch.

public ulong? GasPrice { get; init; }

Property Value​

UInt64?

Name​

Validator's name.

public string? Name { get; init; }

Property Value​

String

ImageUrl​

Validator's url containing their custom image.

public string? ImageUrl { get; init; }

Property Value​

String

NextEpochCommissionRate​

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

public int? NextEpochCommissionRate { get; init; }

Property Value​

Int32?

NextEpochCredentials​

Validator's credentials for the next epoch.

public ValidatorCredentials? NextEpochCredentials { get; init; }

Property Value​

ValidatorCredentials

NextEpochGasPrice​

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

public ulong? NextEpochGasPrice { get; init; }

Property Value​

UInt64?

NextEpochStake​

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

public ulong? NextEpochStake { get; init; }

Property Value​

UInt64?

OperationCap​

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.

public Byte[]? OperationCap { get; init; }

Property Value​

Byte[]

PendingPoolTokenWithdraw​

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

public ulong? PendingPoolTokenWithdraw { get; init; }

Property Value​

UInt64?

PendingStake​

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

public ulong? PendingStake { get; init; }

Property Value​

UInt64?

PendingTotalIotaWithdraw​

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

public ulong? PendingTotalIotaWithdraw { get; init; }

Property Value​

UInt64?

PoolTokenBalance​

Total number of pool tokens issued by the pool.

public ulong? PoolTokenBalance { get; init; }

Property Value​

UInt64?

ProjectUrl​

Validator's homepage URL.

public string? ProjectUrl { get; init; }

Property Value​

String

RewardsPool​

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

public ulong? RewardsPool { get; init; }

Property Value​

UInt64?

StakingPoolActivationEpoch​

The epoch at which this pool became active.

public ulong? StakingPoolActivationEpoch { get; init; }

Property Value​

UInt64?

StakingPoolIotaBalance​

The total number of IOTA tokens in this pool.

public ulong? StakingPoolIotaBalance { get; init; }

Property Value​

UInt64?

VotingPower​

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

public int? VotingPower { get; init; }

Property Value​

Int32?

Constructors​

Validator(Address, ObjectId, Int32?, Int32?, ValidatorCredentials, String, UInt64?, UInt64?, String, String, Int32?, ValidatorCredentials, UInt64?, UInt64?, Byte[], UInt64?, UInt64?, UInt64?, UInt64?, String, UInt64?, UInt64?, UInt64?, Int32?)​

Represents a validator in the system.

public Validator(Address Address, ObjectId StakingPoolId, int? Apy = null, int? CommissionRate = null, ValidatorCredentials? Credentials = null, string? Description = null, ulong? ExchangeRatesSize = null, ulong? GasPrice = null, string? Name = null, string? ImageUrl = null, int? NextEpochCommissionRate = null, ValidatorCredentials? NextEpochCredentials = null, ulong? NextEpochGasPrice = null, ulong? NextEpochStake = null, Byte[]? OperationCap = null, ulong? PendingPoolTokenWithdraw = null, ulong? PendingStake = null, ulong? PendingTotalIotaWithdraw = null, ulong? PoolTokenBalance = null, string? ProjectUrl = null, ulong? RewardsPool = null, ulong? StakingPoolActivationEpoch = null, ulong? StakingPoolIotaBalance = null, int? VotingPower = null)

Parameters​

Address Address
The validator's address.

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

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

CommissionRate Int32?
The fee charged by the validator for staking services.

Credentials ValidatorCredentials?
Validator's credentials.

Description String?
Validator's description.

ExchangeRatesSize UInt64?
Number of exchange rates in the table.

GasPrice UInt64?
The reference gas price for this epoch.

Name String?
Validator's name.

ImageUrl String?
Validator's url containing their custom image.

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

NextEpochCredentials ValidatorCredentials?
Validator's credentials for the next epoch.

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

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

OperationCap Byte[]?
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 UInt64?
Pending pool token withdrawn during the current epoch, emptied at epoch boundaries. Zero for past epochs.

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

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

PoolTokenBalance UInt64?
Total number of pool tokens issued by the pool.

ProjectUrl String?
Validator's homepage URL.

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

StakingPoolActivationEpoch UInt64?
The epoch at which this pool became active.

StakingPoolIotaBalance UInt64?
The total number of IOTA tokens in this pool.

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

Remarks:

UniFFI Warning: Optional parameters have been reordered because of a C# syntax limitation. Use named parameters for compatibility with future ordering changes.

Methods​

Dispose()​

public void Dispose()