• Home
• io.provenance.explorer
• explorer-api-client
• 5.10.0
• source code
• TransactionClient.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

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.MsgTypeSet
import io.provenance.explorer.model.TxDetails
import io.provenance.explorer.model.TxGov
import io.provenance.explorer.model.TxHeatmapRes
import io.provenance.explorer.model.TxMessage
import io.provenance.explorer.model.TxStatus
import io.provenance.explorer.model.TxSummary
import io.provenance.explorer.model.TxType
import io.provenance.explorer.model.base.DateTruncGranularity
import io.provenance.explorer.model.base.PagedResults
import io.provenance.explorer.model.base.Timeframe
import io.provenance.explorer.model.download.TxHistoryChartData
import org.joda.time.DateTime

object TransactionRoutes {
    const val TX_V2 = "${BaseRoutes.V2_BASE}/txs"
    const val TX_V3 = "${BaseRoutes.V3_BASE}/txs"
    const val HISTORY = "$TX_V3/history"
    const val RECENT = "$TX_V2/recent"
    const val TX = "$TX_V2/{hash}"
    const val TX_MSGS = "$TX_V2/{hash}/msgs"
    const val TX_JSON = "$TX_V2/{hash}/json"
    const val TX_TYPES = "$TX_V3/{hash}/types"
    const val TXS_AT_HEIGHT = "$TX_V2/height/{height}"
    const val HEATMAP = "$TX_V3/heatmap"
    const val TYPES = "$TX_V2/types"
    const val TYPES_BY_MODULE = "$TX_V2/types/{module}"
    const val TXS_BY_MODULE = "$TX_V2/module/{module}"
    const val TXS_BY_ADDRESS = "$TX_V2/address/{address}"
    const val TXS_BY_NFT = "$TX_V2/nft/{nftAddr}"
    const val TXS_BY_MODULE_GOV = "$TX_V2/module/gov"
    const val TXS_BY_MODULE_SMART_CONTRACT = "$TX_V2/module/smart_contract"
    const val TXS_BY_IBC_CHAIN = "$TX_V2/ibc/chain/{ibcChain}"
}

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

    @RequestLine("GET ${TransactionRoutes.HISTORY}?fromDate={fromDate}&toDate={toDate}&granularity={granularity}")
    fun history(
        @Param("fromDate") fromDate: DateTime? = null,
        @Param("toDate") toDate: DateTime? = null,
        @Param("granularity") granularity: DateTruncGranularity = DateTruncGranularity.DAY
    ): List

    @RequestLine("GET ${TransactionRoutes.RECENT}?$PAGE_PARAMETERS&fromDate={fromDate}&toDate={toDate}&txStatus={txStatus}&msgType={msgType}")
    fun recentTxs(
        @Param("count") count: Int = 10,
        @Param("page") page: Int = 1,
        @Param("msgType") msgType: String? = null,
        @Param("txStatus") txStatus: TxStatus? = null,
        @Param("fromDate") fromDate: DateTime? = null,
        @Param("toDate") toDate: DateTime? = null
    ): PagedResults

    @RequestLine("GET ${TransactionRoutes.TX}?blockHeight={blockHeight}")
    fun tx(
        @Param("hash") hash: String,
        @Param("blockHeight") blockHeight: Int? = null
    ): TxDetails

    @RequestLine("GET ${TransactionRoutes.TX_MSGS}?$PAGE_PARAMETERS&blockHeight={blockHeight}&msgType={msgType}")
    fun txMsgs(
        @Param("hash") hash: String,
        @Param("blockHeight") blockHeight: Int? = null,
        @Param("count") count: Int = 10,
        @Param("page") page: Int = 1,
        @Param("msgType") msgType: String? = null
    ): PagedResults

    @RequestLine("GET ${TransactionRoutes.TX_JSON}?blockHeight={blockHeight}")
    fun txJson(
        @Param("hash") hash: String,
        @Param("blockHeight") blockHeight: Int? = null
    ): String

    @RequestLine("GET ${TransactionRoutes.TX_TYPES}?blockHeight={blockHeight}")
    fun txTypes(
        @Param("hash") hash: String,
        @Param("blockHeight") blockHeight: Int? = null
    ): List

    @RequestLine("GET ${TransactionRoutes.TXS_AT_HEIGHT}?$PAGE_PARAMETERS&blockHeight={blockHeight}")
    fun txsAtHeight(
        @Param("blockHeight") blockHeight: Int,
        @Param("count") count: Int = 10,
        @Param("page") page: Int = 1
    ): PagedResults

    @RequestLine("GET ${TransactionRoutes.HEATMAP}?fromDate={fromDate}&toDate={toDate}&timeframe={timeframe}")
    fun heatmap(
        @Param("fromDate") fromDate: DateTime? = null,
        @Param("toDate") toDate: DateTime? = null,
        @Param("timeframe") timeframe: Timeframe = Timeframe.FOREVER
    ): TxHeatmapRes

    @RequestLine("GET ${TransactionRoutes.TYPES}")
    fun types(): List

    @RequestLine("GET ${TransactionRoutes.TYPES_BY_MODULE}")
    fun typesByModule(@Param("module") module: MsgTypeSet): List

    @RequestLine("GET ${TransactionRoutes.TXS_BY_MODULE}?$PAGE_PARAMETERS&msgType={msgType}&txStatus={txStatus}&address={address}&denom={denom}&nftAddr={nftAddr}&ibcChain={ibcChain}&ibcSrcPort={ibcSrcPort}&ibcSrcChannel={ibcSrcChannel}&fromDate={fromDate}&toDate={toDate}")
    fun txsByModule(
        @Param("module") module: MsgTypeSet,
        @Param("count") count: Int = 10,
        @Param("page") page: Int = 1,
        @Param("msgType") msgType: String? = null,
        @Param("txStatus") txStatus: TxStatus? = null,
        @Param("address") address: String? = null,
        @Param("denom") denom: String? = null,
        @Param("nftAddr") nftAddr: String? = null,
        @Param("ibcChain") ibcChain: String? = null,
        @Param("ibcSrcPort") ibcSrcPort: String? = null,
        @Param("ibcSrcChannel") ibcSrcChannel: String? = null,
        @Param("fromDate") fromDate: DateTime? = null,
        @Param("toDate") toDate: DateTime? = null
    ): PagedResults

    @RequestLine("GET ${TransactionRoutes.TXS_BY_ADDRESS}?$PAGE_PARAMETERS&msgType={msgType}&txStatus={txStatus}&fromDate={fromDate}&toDate={toDate}")
    fun txsByAddress(
        @Param("address") address: String,
        @Param("count") count: Int = 10,
        @Param("page") page: Int = 1,
        @Param("msgType") msgType: String? = null,
        @Param("txStatus") txStatus: TxStatus? = null,
        @Param("fromDate") fromDate: DateTime? = null,
        @Param("toDate") toDate: DateTime? = null
    ): PagedResults

    @RequestLine("GET ${TransactionRoutes.TXS_BY_NFT}?$PAGE_PARAMETERS&msgType={msgType}&txStatus={txStatus}&fromDate={fromDate}&toDate={toDate}")
    fun txsByNft(
        @Param("nftAddr") nftAddr: String,
        @Param("count") count: Int = 10,
        @Param("page") page: Int = 1,
        @Param("msgType") msgType: String? = null,
        @Param("txStatus") txStatus: TxStatus? = null,
        @Param("fromDate") fromDate: DateTime? = null,
        @Param("toDate") toDate: DateTime? = null
    ): PagedResults

    @RequestLine("GET ${TransactionRoutes.TXS_BY_MODULE_GOV}?$PAGE_PARAMETERS&address={address}&msgType={msgType}&txStatus={txStatus}&fromDate={fromDate}&toDate={toDate}")
    fun txsByModuleGov(
        @Param("count") count: Int = 10,
        @Param("page") page: Int = 1,
        @Param("address") address: String? = null,
        @Param("msgType") msgType: String? = null,
        @Param("txStatus") txStatus: TxStatus? = null,
        @Param("fromDate") fromDate: DateTime? = null,
        @Param("toDate") toDate: DateTime? = null
    ): PagedResults

    @RequestLine("GET ${TransactionRoutes.TXS_BY_MODULE_SMART_CONTRACT}?$PAGE_PARAMETERS&code={code}&contract={contract}&msgType={msgType}&txStatus={txStatus}&fromDate={fromDate}&toDate={toDate}")
    fun txsByModuleSmartContract(
        @Param("count") count: Int = 10,
        @Param("page") page: Int = 1,
        @Param("code") code: Int? = null,
        @Param("contract") contract: String? = null,
        @Param("msgType") msgType: String? = null,
        @Param("txStatus") txStatus: TxStatus? = null,
        @Param("fromDate") fromDate: DateTime? = null,
        @Param("toDate") toDate: DateTime? = null
    ): PagedResults

    @RequestLine("GET ${TransactionRoutes.TXS_BY_IBC_CHAIN}?$PAGE_PARAMETERS&msgType={msgType}&txStatus={txStatus}&ibcSrcPort={ibcSrcPort}&ibcSrcChannel={ibcSrcChannel}&fromDate={fromDate}&toDate={toDate}")
    fun txsByIbcChain(
        @Param("ibcChain") ibcChain: String,
        @Param("count") count: Int = 10,
        @Param("page") page: Int = 1,
        @Param("msgType") msgType: String? = null,
        @Param("txStatus") txStatus: TxStatus? = null,
        @Param("ibcSrcPort") ibcSrcPort: String? = null,
        @Param("ibcSrcChannel") ibcSrcChannel: String? = null,
        @Param("fromDate") fromDate: DateTime? = null,
        @Param("toDate") toDate: DateTime? = null
    ): PagedResults
}