io.provenance.explorer.client.ValidatorClient.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of explorer-api-client Show documentation
API models used by the Provenance Explorer API
There is a newer version: 6.0.0
package io.provenance.explorer.client

import feign.Headers
import feign.Param
import feign.RequestLine
import io.provenance.explorer.client.BaseRoutes.PAGE_PARAMETERS
import io.provenance.explorer.model.BlockLatencyData
import io.provenance.explorer.model.Delegation
import io.provenance.explorer.model.MarketRateAvg
import io.provenance.explorer.model.MetricPeriod
import io.provenance.explorer.model.MissedBlocksTimeframe
import io.provenance.explorer.model.UnpaginatedDelegation
import io.provenance.explorer.model.UptimeDataSet
import io.provenance.explorer.model.ValidatorAtHeight
import io.provenance.explorer.model.ValidatorCommission
import io.provenance.explorer.model.ValidatorCommissionHistory
import io.provenance.explorer.model.ValidatorDetails
import io.provenance.explorer.model.ValidatorMarketRate
import io.provenance.explorer.model.ValidatorMetrics
import io.provenance.explorer.model.ValidatorState
import io.provenance.explorer.model.ValidatorSummary
import io.provenance.explorer.model.ValidatorSummaryAbbrev
import io.provenance.explorer.model.base.PagedResults
import io.provenance.explorer.model.base.Timeframe
import org.joda.time.DateTime

object ValidatorRoutes {
    const val VALIDATOR_V2 = "${BaseRoutes.V2_BASE}/validators"
    const val VALIDATOR_V3 = "${BaseRoutes.V3_BASE}/validators"
    const val RECENT = "$VALIDATOR_V3/recent"
    const val VALIDATORS_AT_HEIGHT = "$VALIDATOR_V2/height/{blockHeight}"
    const val RECENT_ABBREV = "$VALIDATOR_V2/recent/abbrev"
    const val VALIDATOR = "$VALIDATOR_V2/{address}"
    const val VALIDATOR_BONDED = "$VALIDATOR_V2/{address}/delegations/bonded"
    const val VALIDATOR_UNBONDING = "$VALIDATOR_V2/{address}/delegations/unbonding"
    const val VALIDATOR_COMMISSION = "$VALIDATOR_V2/{address}/commission"
    const val VALIDATOR_COMMISSION_HISTORY = "$VALIDATOR_V2/{address}/commission/history"
    const val VALIDATOR_MARKET_RATE = "$VALIDATOR_V2/{address}/market_rate"
    const val VALIDATOR_MARKET_RATE_PERIOD = "$VALIDATOR_V2/{address}/market_rate/period"
    const val VALIDATOR_LATENCY = "$VALIDATOR_V2/{address}/latency"
    const val MISSED_BLOCKS_DISTINCT = "$VALIDATOR_V2/missed_blocks/distinct"
    const val MISSED_BLOCKS = "$VALIDATOR_V2/missed_blocks"
    const val UPTIME = "$VALIDATOR_V2/uptime"
    const val VALIDATOR_METRICS = "$VALIDATOR_V3/{address}/metrics"
    const val VALIDATOR_METRICS_PERIODS = "$VALIDATOR_V3/{address}/metrics/periods"
    const val ALL_METRICS_PERIODS = "$VALIDATOR_V3/metrics/periods"
}

@Headers(BaseClient.CT_JSON)
interface ValidatorClient : BaseClient {

    @RequestLine("GET ${ValidatorRoutes.RECENT}?$PAGE_PARAMETERS&status={status}")
    fun recentValidators(
        @Param("count") count: Int = 10,
        @Param("page") page: Int = 1,
        @Param("status") status: ValidatorState = ValidatorState.ACTIVE
    ): PagedResults

    @RequestLine("GET ${ValidatorRoutes.VALIDATORS_AT_HEIGHT}?$PAGE_PARAMETERS")
    fun validatorsAtHeight(
        @Param("blockHeight") blockHeight: Int,
        @Param("count") count: Int = 10,
        @Param("page") page: Int = 1
    ): PagedResults

    @RequestLine("GET ${ValidatorRoutes.RECENT_ABBREV}")
    fun allValidatorsAbbreviated(): PagedResults

    @RequestLine("GET ${ValidatorRoutes.VALIDATOR}")
    fun validator(@Param("address") address: String): ValidatorDetails

    @RequestLine("GET ${ValidatorRoutes.VALIDATOR_BONDED}")
    fun validatorBondedDelegations(
        @Param("address") address: String,
        @Param("count") count: Int = 10,
        @Param("page") page: Int = 1
    ): PagedResults

    @RequestLine("GET ${ValidatorRoutes.VALIDATOR_UNBONDING}")
    fun validatorUnbondingDelegations(@Param("address") address: String): UnpaginatedDelegation

    @RequestLine("GET ${ValidatorRoutes.VALIDATOR_COMMISSION}")
    fun validatorCommission(@Param("address") address: String): ValidatorCommission

    @RequestLine("GET ${ValidatorRoutes.VALIDATOR_COMMISSION_HISTORY}")
    fun validatorCommissionHistory(@Param("address") address: String): ValidatorCommissionHistory

    @RequestLine("GET ${ValidatorRoutes.VALIDATOR_MARKET_RATE}?txCount={txCount}")
    fun validatorAvgMarketRate(
        @Param("address") address: String,
        @Param("txCount") txCount: Int = 500
    ): MarketRateAvg

    @RequestLine("GET ${ValidatorRoutes.VALIDATOR_MARKET_RATE_PERIOD}?fromDate={fromDate}&toDate={toDate}&dayCount={dayCount}")
    fun validatorMarketRateOverTime(
        @Param("address") address: String,
        @Param("fromDate") fromDate: DateTime? = null,
        @Param("toDate") toDate: DateTime? = null,
        @Param("dayCount") dayCount: Int = 14
    ): List

    @RequestLine("GET ${ValidatorRoutes.VALIDATOR_LATENCY}?blockCount={blockCount}")
    fun validatorLatency(
        @Param("address") address: String,
        @Param("blockCount") blockCount: Int = 100
    ): BlockLatencyData

    @RequestLine("GET ${ValidatorRoutes.MISSED_BLOCKS_DISTINCT}?timeframe={timeframe}")
    fun distinctValidatorsWithMissedBlocks(
        @Param("timeframe") timeframe: Timeframe = Timeframe.HOUR
    ): MissedBlocksTimeframe

    @RequestLine("GET ${ValidatorRoutes.MISSED_BLOCKS}?timeframe={timeframe}&validatorAddr={validatorAddr}")
    fun validatorsWithMissedBocks(
        @Param("timeframe") timeframe: Timeframe = Timeframe.HOUR,
        @Param("validatorAddr") validatorAddr: String
    ): MissedBlocksTimeframe

    @RequestLine("GET ${ValidatorRoutes.UPTIME}")
    fun uptimeData(): UptimeDataSet

    @RequestLine("GET ${ValidatorRoutes.VALIDATOR_METRICS}?address={address}&year={year}&quarter={quarter}")
    fun validatorMetrics(
        @Param("address") address: String,
        @Param("year") year: Int,
        @Param("quarter") quarter: Int
    ): ValidatorMetrics

    @RequestLine("GET ${ValidatorRoutes.VALIDATOR_METRICS_PERIODS}")
    fun validatorMetricsPeriods(@Param("address") address: String): MutableList

    @RequestLine("GET ${ValidatorRoutes.ALL_METRICS_PERIODS}")
    fun allMetricsPeriods(): MutableList
}