Skip to main content

IotaValidatorSummary

@iota/iota-sdk

@iota/iota-sdk / client / IotaValidatorSummary

Interface: IotaValidatorSummary

Defined in: sdk/typescript/src/client/types/generated.ts:1046

This is the JSON-RPC type for the IOTA validator. It flattens all inner structures to top-level fields so that they are decoupled from the internal definitions.

Properties​

authorityPubkeyBytes​

authorityPubkeyBytes: string

Defined in: sdk/typescript/src/client/types/generated.ts:1047

commissionRate​

commissionRate: string

Defined in: sdk/typescript/src/client/types/generated.ts:1054

The fee set by the validator for providing staking services.

This might be overridden by the protocol, that uses instead an effective commission rate. See more on the associated field.

description​

description: string

Defined in: sdk/typescript/src/client/types/generated.ts:1055

effectiveCommissionRate?​

optional effectiveCommissionRate?: string | null

Defined in: sdk/typescript/src/client/types/generated.ts:1061

The effective fee charged by the validator for staking services.

This follows IIP8.

exchangeRatesId​

exchangeRatesId: string

Defined in: sdk/typescript/src/client/types/generated.ts:1063

ID of the exchange rate table object.

exchangeRatesSize​

exchangeRatesSize: string

Defined in: sdk/typescript/src/client/types/generated.ts:1065

Number of exchange rates in the table.

gasPrice​

gasPrice: string

Defined in: sdk/typescript/src/client/types/generated.ts:1066

imageUrl​

imageUrl: string

Defined in: sdk/typescript/src/client/types/generated.ts:1067

iotaAddress​

iotaAddress: string

Defined in: sdk/typescript/src/client/types/generated.ts:1068

name​

name: string

Defined in: sdk/typescript/src/client/types/generated.ts:1069

netAddress​

netAddress: string

Defined in: sdk/typescript/src/client/types/generated.ts:1070

networkPubkeyBytes​

networkPubkeyBytes: string

Defined in: sdk/typescript/src/client/types/generated.ts:1071

nextEpochAuthorityPubkeyBytes?​

optional nextEpochAuthorityPubkeyBytes?: string | null

Defined in: sdk/typescript/src/client/types/generated.ts:1072

nextEpochCommissionRate​

nextEpochCommissionRate: string

Defined in: sdk/typescript/src/client/types/generated.ts:1073

nextEpochGasPrice​

nextEpochGasPrice: string

Defined in: sdk/typescript/src/client/types/generated.ts:1074

nextEpochNetAddress?​

optional nextEpochNetAddress?: string | null

Defined in: sdk/typescript/src/client/types/generated.ts:1075

nextEpochNetworkPubkeyBytes?​

optional nextEpochNetworkPubkeyBytes?: string | null

Defined in: sdk/typescript/src/client/types/generated.ts:1076

nextEpochP2pAddress?​

optional nextEpochP2pAddress?: string | null

Defined in: sdk/typescript/src/client/types/generated.ts:1077

nextEpochPrimaryAddress?​

optional nextEpochPrimaryAddress?: string | null

Defined in: sdk/typescript/src/client/types/generated.ts:1078

nextEpochProofOfPossession?​

optional nextEpochProofOfPossession?: string | null

Defined in: sdk/typescript/src/client/types/generated.ts:1079

nextEpochProtocolPubkeyBytes?​

optional nextEpochProtocolPubkeyBytes?: string | null

Defined in: sdk/typescript/src/client/types/generated.ts:1080

nextEpochStake​

nextEpochStake: string

Defined in: sdk/typescript/src/client/types/generated.ts:1081

operationCapId​

operationCapId: string

Defined in: sdk/typescript/src/client/types/generated.ts:1082

p2pAddress​

p2pAddress: string

Defined in: sdk/typescript/src/client/types/generated.ts:1083

pendingPoolTokenWithdraw​

pendingPoolTokenWithdraw: string

Defined in: sdk/typescript/src/client/types/generated.ts:1085

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

pendingStake​

pendingStake: string

Defined in: sdk/typescript/src/client/types/generated.ts:1087

Pending stake amount for this epoch.

pendingTotalIotaWithdraw​

pendingTotalIotaWithdraw: string

Defined in: sdk/typescript/src/client/types/generated.ts:1089

Pending stake withdrawn during the current epoch, emptied at epoch boundaries.

poolTokenBalance​

poolTokenBalance: string

Defined in: sdk/typescript/src/client/types/generated.ts:1091

Total number of pool tokens issued by the pool.

primaryAddress​

primaryAddress: string

Defined in: sdk/typescript/src/client/types/generated.ts:1092

projectUrl​

projectUrl: string

Defined in: sdk/typescript/src/client/types/generated.ts:1093

proofOfPossessionBytes​

proofOfPossessionBytes: string

Defined in: sdk/typescript/src/client/types/generated.ts:1094

protocolPubkeyBytes​

protocolPubkeyBytes: string

Defined in: sdk/typescript/src/client/types/generated.ts:1095

rewardsPool​

rewardsPool: string

Defined in: sdk/typescript/src/client/types/generated.ts:1097

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

stakingPoolActivationEpoch?​

optional stakingPoolActivationEpoch?: string | null

Defined in: sdk/typescript/src/client/types/generated.ts:1099

The epoch at which this pool became active.

stakingPoolDeactivationEpoch?​

optional stakingPoolDeactivationEpoch?: string | null

Defined in: sdk/typescript/src/client/types/generated.ts:1101

The epoch at which this staking pool ceased to be active. None = {pre-active, active},

stakingPoolId​

stakingPoolId: string

Defined in: sdk/typescript/src/client/types/generated.ts:1103

ID of the staking pool object.

stakingPoolIotaBalance​

stakingPoolIotaBalance: string

Defined in: sdk/typescript/src/client/types/generated.ts:1105

The total number of IOTA tokens in this pool.

votingPower​

votingPower: string

Defined in: sdk/typescript/src/client/types/generated.ts:1106