io.provenance.explorer.client.AssetClient.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 com.fasterxml.jackson.databind.node.ObjectNode
import feign.Headers
import feign.Param
import feign.RequestLine
import io.provenance.explorer.client.BaseRoutes.PAGE_PARAMETERS
import io.provenance.explorer.model.AssetDetail
import io.provenance.explorer.model.AssetHolder
import io.provenance.explorer.model.AssetListed
import io.provenance.explorer.model.IbcDenomDetail
import io.provenance.explorer.model.base.PagedResults
import io.provenance.marker.v1.MarkerStatus

object AssetRoutes {
    const val ASSETS_V2 = "${BaseRoutes.V2_BASE}/assets"
    const val ASSETS_V3 = "${BaseRoutes.V3_BASE}/assets"
    const val ALL = "$ASSETS_V2/all"
    const val DETAIL = "$ASSETS_V3/{denom}"
    const val DETAIL_IBC = "$ASSETS_V3/ibc/{hash}"
    const val HOLDERS = "$ASSETS_V3/{denom}/holders"
    const val METADATA = "$ASSETS_V3/metadata"
}

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

    @RequestLine("GET ${AssetRoutes.ALL}?$PAGE_PARAMETERS&statuses={statuses}")
    fun all(
        @Param("statuses") statuses: List = listOf(MarkerStatus.MARKER_STATUS_ACTIVE),
        @Param("count") count: Int = 10,
        @Param("page") page: Int = 1
    ): PagedResults

    @RequestLine("GET ${AssetRoutes.DETAIL}")
    fun asset(@Param("denom") denom: String): AssetDetail

    @RequestLine("GET ${AssetRoutes.DETAIL_IBC}")
    fun ibcAsset(@Param("hash") hash: String): IbcDenomDetail

    @RequestLine("GET ${AssetRoutes.HOLDERS}?$PAGE_PARAMETERS")
    fun assetHolders(
        @Param("denom") denom: String,
        @Param("count") count: Int = 10,
        @Param("page") page: Int = 1
    ): PagedResults

    @RequestLine("GET ${AssetRoutes.METADATA}?denom={denom}")
    fun metadata(@Param("denom") denom: String? = null): List
}