enums

Documentation

Index

• type ColumnName
  • func (e ColumnName) ToString() string
• type MetricType
  • func (e MetricType) ToString() string
• type MonitorType
  • func (e MonitorType) ToString() string
• type PortType
• type PrometheusMetricName
  • func (e PrometheusMetricName) ToString() string
• type PrometheusMetricType
• type RPCMethod
  • func (e RPCMethod) String() string
• type Status
  • func (i Status) ColorStatus() string
  • func (i Status) DashboardStatus() string
  • func (i Status) StatusToPlaceholder() string
• type TableType
  • func (e TableType) ToString() string
• type WidgetType

Types

type ColumnName

type ColumnName string

const (
	ColumnNameIndex   ColumnName = "IDX"
	ColumnNameHealth  ColumnName = "HEALTH"
	ColumnNameAddress ColumnName = "ADDRESS"
	ColumnNamePortRPC ColumnName = "RPC"
	ColumnNameUptime  ColumnName = "UPTIME DAYS"
	ColumnNameVersion ColumnName = "VERSION"
	ColumnNameCommit  ColumnName = "COMMIT"
	ColumnNameCountry ColumnName = "COUNTRY"
)

Overview section

const (
	ColumnNameTotalTransactionBlocks                  ColumnName = "TOTAL TX\nBLOCKS"
	ColumnNameTotalTransactionCertificates            ColumnName = "TOTAL TX\nCERTIFICATES"
	ColumnNameTotalTransactionEffects                 ColumnName = "TOTAL TX\nEFFECTS"
	ColumnNameTXSyncPercentage                        ColumnName = "TX SYNC PCT"
	ColumnNameSkippedConsensusTransactions            ColumnName = "SKIPPED\nCONSENSUS TX"
	ColumnNameCertificatesCreated                     ColumnName = "CERTIFICATES\nCREATED"
	ColumnNameHandleCertificateNonConsensusLatencySum ColumnName = "CERTIFICATE\nNON CONSENSUS LATENCY"
	ColumnNameTotalSignatureErrors                    ColumnName = "SIGNATURE\nERRORS"
	ColumnNameTransactionsPerSecond                   ColumnName = "TRANSACTIONS PER SECOND"
	ColumnNameCertificatesPerSecond                   ColumnName = "CERTIFICATES PER SECOND"
)

Transactions section

const (
	ColumnNameLatestCheckpoint        ColumnName = "LATEST\nCHECKPOINT"
	ColumnNameHighestKnownCheckpoint  ColumnName = "HIGHEST KNOWN\nCHECKPOINT"
	ColumnNameLastExecutedCheckpoint  ColumnName = "LAST EXECUTED\nCHECKPOINT"
	ColumnNameHighestSyncedCheckpoint ColumnName = "HIGHEST SYNCED\nCHECKPOINT"
	ColumnNameCheckpointExecBacklog   ColumnName = "CHECKPOINT\nEXEC BACKLOG"
	ColumnNameCheckpointSyncBacklog   ColumnName = "CHECKPOINT\nSYNC BACKLOG"
	ColumnNameCheckSyncPercentage     ColumnName = "CHECKPOINT\nSYNC PCT"
	ColumnNameCheckpointsPerSecond    ColumnName = "CHECKPOINTS PER SECOND"
)

Checkpoints section

const (
	ColumnNameCurrentRound          ColumnName = "CURRENT\nROUND"
	ColumnNameHighestProcessedRound ColumnName = "HIGHEST\nPROCESSED ROUND"
	ColumnNameLastCommittedRound    ColumnName = "LAST COMMITTED\nROUND"
	ColumnNameRoundsPerSecond       ColumnName = "ROUNDS PER SECOND"
)

Rounds section

const (
	ColumnNameNetworkPeers        ColumnName = "NETWORK\nPEERS"
	ColumnNamePrimaryNetworkPeers ColumnName = "PRIMARY\nNETWORK PEERS"
	ColumnNameWorkerNetworkPeers  ColumnName = "WORKER\nNETWORK PEERS"
)

Peers section

const (
	ColumnNameValidatorName                     ColumnName = "NAME"
	ColumnNameValidatorNetAddress               ColumnName = "NET ADDRESS"
	ColumnNameValidatorVotingPower              ColumnName = "VOTING\nPOWER"
	ColumnNameValidatorGasPrice                 ColumnName = "GAS\nPRICE"
	ColumnNameValidatorCommissionRate           ColumnName = "COMMISSION\nRATE"
	ColumnNameValidatorNextEpochStake           ColumnName = "NEXT EPOCH\nSTAKE, SUI"
	ColumnNameValidatorNextEpochGasPrice        ColumnName = "NEXT EPOCH\nGAS PRICE"
	ColumnNameValidatorNextEpochCommissionRate  ColumnName = "NEXT EPOCH\nCOMMISSION RATE"
	ColumnNameValidatorStakingPoolSuiBalance    ColumnName = "STAKING POOL SUI\nBALANCE, SUI"
	ColumnNameValidatorRewardsPool              ColumnName = "REWARDS POOL, SUI"
	ColumnNameValidatorPoolTokenBalance         ColumnName = "POOL TOKEN\nBALANCE, SUI"
	ColumnNameValidatorPendingStake             ColumnName = "PENDING STAKE, SUI"
	ColumnNameValidatorPendingTotalSuiWithdraw  ColumnName = "PENDING TOTAL\nSUI WITHDRAW"
	ColumnNameValidatorPendingPoolTokenWithdraw ColumnName = "PENDING POOL\nTOKEN WITHDRAW"
	ColumnNameValidatorApy                      ColumnName = "APY, %"
)

Validator section

const (
	ColumnNameEpoch                             ColumnName = "EPOCH"
	ColumnNameEpochTotalTransactions            ColumnName = "TOTAL\nTRANSACTIONS"
	ColumnNameEpochStartTimestamp               ColumnName = "EPOCH START TIME UTC"
	ColumnNameEpochEndTimestamp                 ColumnName = "EPOCH END TIME UTC"
	ColumnNameEpochFirstCheckpointId            ColumnName = "FIRST\nCHECKPOINT ID"
	ColumnNameEpochLastCheckpointId             ColumnName = "LAST\nCHECKPOINT ID"
	ColumnNameEpochProtocolVersion              ColumnName = "PROTOCOL\nVERSION"
	ColumnNameEpochReferenceGasPrice            ColumnName = "REFERENCE\nGAS PRICE"
	ColumnNameEpochTotalStake                   ColumnName = "TOTAL STAKE,\nSUI"
	ColumnNameEpochStorageFundReinvestment      ColumnName = "STORAGE FUND\nREINVESTMENT, SUI"
	ColumnNameEpochStorageCharge                ColumnName = "STORAGE\nCHARGE, SUI"
	ColumnNameEpochStorageRebate                ColumnName = "STORAGE\nREBATE, SUI"
	ColumnNameEpochStorageFundBalance           ColumnName = "STORAGE FUND\nBALANCE, SUI"
	ColumnNameEpochStakeSubsidyAmount           ColumnName = "STORAGE SUBSIDY\nAMOUNT, SUI"
	ColumnNameEpochTotalGasFees                 ColumnName = "TOTAL GAS\nFEES, SUI"
	ColumnNameEpochTotalStakeRewardsDistributed ColumnName = "TOTAL STAKE REWARDS\nDISTRIBUTED, SUI"
	ColumnNameEpochLeftoverStorageFundInflow    ColumnName = "LEFTOVER STORAGE FUND\nINFLOW, SUI"
)

Epoch section

const (
	ColumnNameCurrentEpoch                                ColumnName = "CURRENT\nEPOCH"
	ColumnNameSystemEpoch                                 ColumnName = "EPOCH"
	ColumnNameSystemEpochStartTimestamp                   ColumnName = "EPOCH START TIME UTC"
	ColumnNameSystemEpochDuration                         ColumnName = "EPOCH\nDURATION"
	ColumnNameSystemTimeTillNextEpoch                     ColumnName = "TIME TILL\nNEXT EPOCH"
	ColumnNameSystemTotalStake                            ColumnName = "TOTAL STAKE, SUI"
	ColumnNameSystemStorageFundTotalObjectStorageRebates  ColumnName = "STORAGE FUND TOTAL\nOBJECT REBATES, SUI"
	ColumnNameSystemStorageFundNonRefundableBalance       ColumnName = "STORAGE FUND\nREFUNDABLE BALANCE, SUI"
	ColumnNameSystemReferenceGasPrice                     ColumnName = "REFERENCE\nGAS PRICE"
	ColumnNameSystemMinReferenceGasPrice                  ColumnName = "MIN REFERENCE\nGAS PRICE"
	ColumnNameSystemMaxReferenceGasPrice                  ColumnName = "MAX REFERENCE\nGAS PRICE"
	ColumnNameSystemMeanReferenceGasPrice                 ColumnName = "MEAN REFERENCE\nGAS PRICE"
	ColumnNameSystemStakeWeightedMeanReferenceGasPrice    ColumnName = "STAKE WEIGHTED MEAN\nREFERENCE GAS PRICE"
	ColumnNameSystemMedianReferenceGasPrice               ColumnName = "MEDIAN REFERENCE\nGAS PRICE"
	ColumnNameSystemEstimatedReferenceGasPrice            ColumnName = "ESTIMATED REFERENCE\nGAS PRICE"
	ColumnNameSystemMaxValidatorCount                     ColumnName = "MAX VALIDATOR\nCOUNT"
	ColumnNameSystemActiveValidatorCount                  ColumnName = "ACTIVE VALIDATOR\nCOUNT"
	ColumnNameSystemPendingActiveValidatorCount           ColumnName = "PENDING ACTIVE\nVALIDATORS COUNT"
	ColumnNameSystemValidatorCandidateCount               ColumnName = "VALIDATOR\nCANDIDATE COUNT"
	ColumnNameSystemPendingRemovalsCount                  ColumnName = "PENDING VALIDATOR\nREMOVALS COUNT"
	ColumnNameSystemAtRiskValidatorCount                  ColumnName = "VALIDATOR AT RISK\nCOUNT"
	ColumnNameSystemMinValidatorJoiningStake              ColumnName = "MIN VALIDATOR\nJOINING STAKE"
	ColumnNameSystemValidatorLowStakeThreshold            ColumnName = "VALIDATOR LOW\nSTAKE THRESHOLD"
	ColumnNameSystemValidatorVeryLowStakeThreshold        ColumnName = "VALIDATOR VERY LOW\nSTAKE THRESHOLD"
	ColumnNameSystemValidatorLowStakeGracePeriod          ColumnName = "VALIDATOR LOW STAKE\nGRACE PERIOD"
	ColumnNameSystemAtRiskValidatorName                   ColumnName = "VALIDATOR NAME"
	ColumnNameSystemAtRiskValidatorAddress                ColumnName = "VALIDATOR ADDRESS"
	ColumnNameSystemAtRiskValidatorNumberOfEpochs         ColumnName = "NUMBER OF EPOCHS\nAT RISK"
	ColumnNameSystemValidatorReporterName                 ColumnName = "REPORTER VALIDATOR"
	ColumnNameSystemValidatorReporterAddress              ColumnName = "REPORTER VALIDATOR ADDRESS"
	ColumnNameSystemValidatorReportedName                 ColumnName = "REPORTED VALIDATOR"
	ColumnNameSystemValidatorSlashingPercentage           ColumnName = "SLASHING PCT"
	ColumnNameSystemStakeSubsidyStartEpoch                ColumnName = "STAKE SUBSIDY\nSTART EPOCH"
	ColumnNameSystemStakeSubsidyBalance                   ColumnName = "STAKE SUBSIDY\nBALANCE, SUI"
	ColumnNameSystemStakeSubsidyDistributionCounter       ColumnName = "STAKE SUBSIDY\nDISTRIBUTION COUNTER"
	ColumnNameSystemStakeSubsidyCurrentDistributionAmount ColumnName = "STAKE SUBSIDY\nDISTRIBUTION AMOUNT, SUI"
	ColumnNameSystemStakeSubsidyPeriodLength              ColumnName = "STAKE SUBSIDY\nPERIOD LENGTH"
	ColumnNameSystemStakeSubsidyDecreaseRate              ColumnName = "STAKE SUBSIDY\nDECREASE RATE"
)

System State section

func (ColumnName) ToString

func (e ColumnName) ToString() string

type MetricType

type MetricType string

const (
	MetricTypeSuiSystemState               MetricType = "SYSTEM_STATE"
	MetricTypeValidatorsApy                MetricType = "VALIDATORS_APY"
	MetricTypeEpochsHistory                MetricType = "EPOCHS_HISTORY"
	MetricTypeTotalTransactionBlocks       MetricType = "TOTAL_TRANSACTION_BLOCKS"
	MetricTypeTotalTransactionCertificates MetricType = "TOTAL_TRANSACTION_CERTIFICATES"
	MetricTypeTotalTransactionEffects      MetricType = "TOTAL_TRANSACTION_EFFECTS"
	MetricTypeTransactionsPerSecond        MetricType = "TRANSACTIONS_PER_SECOND"
	MetricTypeLatestCheckpoint             MetricType = "LATEST_CHECKPOINT"
	MetricTypeHighestKnownCheckpoint       MetricType = "HIGHEST_KNOWN_CHECKPOINT"
	MetricTypeHighestSyncedCheckpoint      MetricType = "HIGHEST_SYNCED_CHECKPOINT"
	MetricTypeLastExecutedCheckpoint       MetricType = "LAST_EXECUTED_CHECKPOINT"
	MetricTypeCheckpointExecBacklog        MetricType = "CHECKPOINT_EXECUTION_BACKLOG"
	MetricTypeCheckpointSyncBacklog        MetricType = "CHECKPOINT_SYNC_BACKLOG"
	MetricTypeCheckpointsPerSecond         MetricType = "CHECKPOINTS_PER_SECOND"
	MetricTypeCurrentEpoch                 MetricType = "CURRENT_EPOCH"
	MetricTypeEpochTotalDuration           MetricType = "EPOCH_TOTAL_DURATION"
	MetricTypeTimeTillNextEpoch            MetricType = "TIME_TILL_NEXT_EPOCH"
	MetricTypeTxSyncPercentage             MetricType = "TX_SYNC_PERCENTAGE"
	MetricTypeCheckSyncPercentage          MetricType = "CHECK_SYNC_PERCENTAGE"
	MetricTypeSuiNetworkPeers              MetricType = "SUI_NETWORK_PEERS"
	MetricTypeUptime                       MetricType = "UPTIME"
	MetricTypeVersion                      MetricType = "VERSION"
	MetricTypeCommit                       MetricType = "COMMIT"
	MetricTypeCurrentRound                 MetricType = "CURRENT_ROUND"
	MetricTypeHighestProcessedRound        MetricType = "HIGHEST_PROCESSED_ROUND"
	MetricTypeLastCommittedRound           MetricType = "LAST_COMMITTED_ROUND"
	MetricTypePrimaryNetworkPeers          MetricType = "PRIMARY_NETWORK_PEERS"
	MetricTypeWorkerNetworkPeers           MetricType = "WORKER_NETWORK_PEERS"
	MetricTypeSkippedConsensusTransactions MetricType = "SKIPPED_CONSENSUS_TRANSACTIONS"
	MetricTypeTotalSignatureErrors         MetricType = "TOTAL_SIGNATURE_ERRORS"
	MetricTypeCertificatesCreated          MetricType = "CERTIFICATES_CREATED"
	MetricTypeNonConsensusLatencySum       MetricType = "NON_CONSENSUS_LATENCY_SUM"
)

func (MetricType) ToString

func (e MetricType) ToString() string

type MonitorType

type MonitorType string

const (
	MonitorTypeStatic  MonitorType = "STATIC"
	MonitorTypeDynamic MonitorType = "DYNAMIC"
)

func (MonitorType) ToString

func (e MonitorType) ToString() string

type PortType

type PortType int

const (
	PortTypeRPC PortType = iota
	PortTypeMetrics
)

type PrometheusMetricName

type PrometheusMetricName string

const (
	PrometheusMetricNameTotalTransactionCertificates PrometheusMetricName = "total_transaction_certificates"
	PrometheusMetricNameTotalTransactionEffects      PrometheusMetricName = "total_transaction_effects"
	PrometheusMetricNameHighestKnownCheckpoint       PrometheusMetricName = "highest_known_checkpoint"
	PrometheusMetricNameHighestSyncedCheckpoint      PrometheusMetricName = "highest_synced_checkpoint"
	PrometheusMetricNameLastExecutedCheckpoint       PrometheusMetricName = "last_executed_checkpoint"
	PrometheusMetricNameCurrentEpoch                 PrometheusMetricName = "current_epoch"
	PrometheusMetricNameEpochTotalDuration           PrometheusMetricName = "epoch_total_duration"
	PrometheusMetricNameCurrentRound                 PrometheusMetricName = "current_round"
	PrometheusMetricNameHighestProcessedRound        PrometheusMetricName = "highest_processed_round"
	PrometheusMetricNameLastCommittedRound           PrometheusMetricName = "last_committed_round"
	PrometheusMetricNamePrimaryNetworkPeers          PrometheusMetricName = "primary_network_peers"
	PrometheusMetricNameWorkerNetworkPeers           PrometheusMetricName = "worker_network_peers"
	PrometheusMetricNameSuiNetworkPeers              PrometheusMetricName = "sui_network_peers"
	PrometheusMetricNameSkippedConsensusTransactions PrometheusMetricName = "skipped_consensus_txns"
	PrometheusMetricNameTotalSignatureErrors         PrometheusMetricName = "total_signature_errors"
	PrometheusMetricNameCertificatesCreated          PrometheusMetricName = "certificates_created"
	PrometheusMetricNameNonConsensusLatencySum       PrometheusMetricName = "validator_service_handle_certificate_non_consensus_latency_sum"
	PrometheusMetricNameUptime                       PrometheusMetricName = "uptime"
)

func (PrometheusMetricName) ToString

func (e PrometheusMetricName) ToString() string

type PrometheusMetricType

type PrometheusMetricType int

const (
	PrometheusMetricTypeCounter PrometheusMetricType = iota
	PrometheusMetricTypeGauge
	PrometheusMetricTypeHistogram
	PrometheusMetricTypeSummary
	PrometheusMetricTypeUntyped
)

type RPCMethod

type RPCMethod string

const (
	RPCMethodGetTotalTransactionBlocks         RPCMethod = "sui_getTotalTransactionBlocks"
	RPCMethodGetSuiSystemState                 RPCMethod = "suix_getLatestSuiSystemState"
	RPCMethodGetLatestCheckpointSequenceNumber RPCMethod = "sui_getLatestCheckpointSequenceNumber"
	RPCMethodGetValidatorsApy                  RPCMethod = "suix_getValidatorsApy"
	RPCMethodGetEpochs                         RPCMethod = "suix_getEpochs"
)

func (RPCMethod) String

func (e RPCMethod) String() string

type Status

type Status string

const (
	StatusGreen  Status = "\U0001F7E9"
	StatusYellow Status = "\U0001F7E8"
	StatusRed    Status = "\U0001F7E5"
	StatusGrey   Status = "\U0001F7E4"
)

func (Status) ColorStatus

func (i Status) ColorStatus() string

func (Status) DashboardStatus

func (i Status) DashboardStatus() string

func (Status) StatusToPlaceholder

func (i Status) StatusToPlaceholder() string

type TableType

type TableType string

const (
	TableTypeRPC                TableType = "📡 PUBLIC RPC"
	TableTypeNode               TableType = "💻 FULL NODES"
	TableTypeValidator          TableType = "🤖 VALIDATORS"
	TableTypeGasPriceAndSubsidy TableType = "💰 EPOCH, GAS AND SUBSIDY"
	TableTypeEpochsHistory      TableType = "⏳ EPOCHS HISTORY"
	TableTypeValidatorsParams   TableType = "📊 VALIDATORS PARAMS"
	TableTypeValidatorsAtRisk   TableType = "🚨 VALIDATORS AT RISK"
	TableTypeValidatorReports   TableType = "📢 VALIDATORS REPORTS"
	TableTypeActiveValidators   TableType = "✅ ACTIVE VALIDATORS"
)

func (TableType) ToString

func (e TableType) ToString() string

type WidgetType

type WidgetType int

const (
	WidgetTypeProgress WidgetType = iota
	WidgetTypeTextNoScroll
	WidgetTypeDisplay
	WidgetTypeSparkLine
)