com.nftco.flow.sdk.FlowAccessApi.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flow-jvm-sdk Show documentation

The Flow Blockchain JVM SDK

The newest version!

package com.nftco.flow.sdk

import com.google.protobuf.ByteString

interface FlowAccessApi {

    fun ping()

    fun getLatestBlockHeader(sealed: Boolean = true): FlowBlockHeader

    fun getBlockHeaderById(id: FlowId): FlowBlockHeader?

    fun getBlockHeaderByHeight(height: Long): FlowBlockHeader?

    fun getLatestBlock(sealed: Boolean = true): FlowBlock

    fun getBlockById(id: FlowId): FlowBlock?

    fun getBlockByHeight(height: Long): FlowBlock?

    fun getCollectionById(id: FlowId): FlowCollection?

    fun sendTransaction(transaction: FlowTransaction): FlowId

    fun getTransactionById(id: FlowId): FlowTransaction?

    fun getTransactionResultById(id: FlowId): FlowTransactionResult?

    @Deprecated(
        message = "Behaves identically to getAccountAtLatestBlock",
        replaceWith = ReplaceWith("getAccountAtLatestBlock")
    )
    fun getAccountByAddress(addresss: FlowAddress): FlowAccount?

    fun getAccountAtLatestBlock(addresss: FlowAddress): FlowAccount?

    fun getAccountByBlockHeight(addresss: FlowAddress, height: Long): FlowAccount?

    fun executeScriptAtLatestBlock(script: FlowScript, arguments: Iterable = emptyList()): FlowScriptResponse

    fun executeScriptAtBlockId(script: FlowScript, blockId: FlowId, arguments: Iterable = emptyList()): FlowScriptResponse

    fun executeScriptAtBlockHeight(script: FlowScript, height: Long, arguments: Iterable = emptyList()): FlowScriptResponse

    fun getEventsForHeightRange(type: String, range: ClosedRange): List

    fun getEventsForBlockIds(type: String, ids: Set): List

    fun getNetworkParameters(): FlowChainId

    fun getLatestProtocolStateSnapshot(): FlowSnapshot
}