QueryApi (heraj 1.3.0 API)

All Known Implementing Classes:: QueryApiImpl

@ApiAudience.Public
 @ApiStability.Unstable
public interface QueryApi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AccountState`	`getAccountState(AccountAddress accountAddress)` Get account state by account.
`BlockHash`	`getBestBlockHash()` Get best block hash.
`long`	`getBestBlockHeight()` Get best block height.
`Block`	`getBlock(BlockHash blockHash)` Get block by hash.
`Block`	`getBlock(long height)` Get block by height.
`BlockchainStatus`	`getBlockchainStatus()` Get blockchain status.
`BlockMetadata`	`getBlockMetadata(BlockHash blockHash)` Get block metadata by hash.
`BlockMetadata`	`getBlockMetadata(long height)` Get block metadata by height.
`ChainIdHash`	`getChainIdHash()` Get chain id hash.
`ChainInfo`	`getChainInfo()` Get chain info of current node.
`ChainStats`	`getChainStats()` Get chain stats of current node.
`ContractInterface`	`getContractInterface(ContractAddress contractAddress)` Get smart contract interface corresponding to contract address.
`AccountAddress`	`getNameOwner(java.lang.String name)` Get owner of an account name.
`AccountAddress`	`getNameOwner(java.lang.String name, long blockNumber)` Get owner of an account name at block number `blockNumber`.
`NodeStatus`	`getNodeStatus()` Get status of current node.
`ContractTxReceipt`	`getReceipt(ContractTxHash contractTxHash)` Get receipt of transaction.
`ServerInfo`	`getServerInfo(java.util.List<java.lang.String> categories)` Get server info of current node.
`StakeInfo`	`getStakingInfo(AccountAddress accountAddress)` Get staking information of `accountAddress`.
`Transaction`	`getTransaction(TxHash txHash)` Get transaction.
`AccountTotalVote`	`getVotesOf(AccountAddress accountAddress)` Get votes which `accountAddress` votes for.
`java.util.List<BlockMetadata>`	`listBlockMetadatas(BlockHash blockHash, int size)` Get block metadatas of `size` backward starting from block for provided hash.
`java.util.List<BlockMetadata>`	`listBlockMetadatas(long height, int size)` Get block metadatas of `size` backward starting from block for provided height.
`java.util.List<ElectedCandidate>`	`listElected(java.lang.String voteId, int showCount)` Get elected candidates per `voteId` for current round.
`java.util.List<ElectedCandidate>`	`listElectedBps(int showCount)` Get elected block producers for current round.
`java.util.List<Event>`	`listEvents(EventFilter filter)` List events corresponding with event filter.
`java.util.List<PeerMetric>`	`listPeerMetrics()` Get metrics of peers.
`java.util.List<Peer>`	`listPeers()` Get blockchain peer addresses filtering hidden peers and itself.
`java.util.List<Peer>`	`listPeers(boolean showHidden, boolean showSelf)` Get blockchain peer addresses.
`java.util.List<AccountAddress>`	`listServerKeyStoreAccounts()` Get account list on a server key store.
`ContractResult`	`query(ContractInvocation contractInvocation)` Query the smart contract state by calling smart contract function.
`Subscription<Event>`	`subscribeEvent(EventFilter filter, StreamObserver<Event> observer)` Subscribe event corresponding with event filter.
`Subscription<Block>`	`subscribeNewBlock(StreamObserver<Block> observer)` Subscribe block stream which is triggered everytime new block is generated.
`Subscription<BlockMetadata>`	`subscribeNewBlockMetadata(StreamObserver<BlockMetadata> observer)` Subscribe block metadata stream which is triggered everytime new block is generated.

- Method Detail
  - getAccountState
```
AccountState getAccountState(AccountAddress accountAddress)
```
    Get account state by account.
    
    Parameters:
    
    accountAddress - account address
    
    Returns:
    
    an account state
  - getNameOwner
```
AccountAddress getNameOwner(java.lang.String name)
```
    Get owner of an account name.
    
    Parameters:
    
    name - an name of account
    
    Returns:
    
    an account address binded with name
  - getNameOwner
```
AccountAddress getNameOwner(java.lang.String name,
                            long blockNumber)
```
    Get owner of an account name at block number blockNumber.
    
    Parameters:
    
    name - an name of account
    
    blockNumber - a block number
    
    Returns:
    
    an account address binded with name
  - getStakingInfo
```
StakeInfo getStakingInfo(AccountAddress accountAddress)
```
    Get staking information of accountAddress.
    
    Parameters:
    
    accountAddress - an account address to check staking information
    
    Returns:
    
    a staking information
  - listElectedBps
```
java.util.List<ElectedCandidate> listElectedBps(int showCount)
```
    Get elected block producers for current round.
    
    Parameters:
    
    showCount - a show count
    
    Returns:
    
    elected block producer list
  - listElected
```
java.util.List<ElectedCandidate> listElected(java.lang.String voteId,
                                             int showCount)
```
    Get elected candidates per voteId for current round.
    
    Parameters:
    
    voteId - a vote id
    
    showCount - a show count
    
    Returns:
    
    elected block producer list
  - getVotesOf
```
AccountTotalVote getVotesOf(AccountAddress accountAddress)
```
    Get votes which accountAddress votes for.
    
    Parameters:
    
    accountAddress - an account address
    
    Returns:
    
    votes list
  - listServerKeyStoreAccounts
```
java.util.List<AccountAddress> listServerKeyStoreAccounts()
```
    Get account list on a server key store.
    
    Returns:
    
    account list
  - getBestBlockHash
```
BlockHash getBestBlockHash()
```
    Get best block hash.
    
    Returns:
    
    block hash
  - getBestBlockHeight
```
long getBestBlockHeight()
```
    Get best block height.
    
    Returns:
    
    block height
  - getChainIdHash
```
ChainIdHash getChainIdHash()
```
    Get chain id hash.
    
    Returns:
    
    a chain id hash
  - getBlockchainStatus
```
BlockchainStatus getBlockchainStatus()
```
    Get blockchain status.
    
    Returns:
    
    blockchain status
  - getChainInfo
```
ChainInfo getChainInfo()
```
    Get chain info of current node.
    
    Returns:
    
    a chain info
  - getChainStats
```
ChainStats getChainStats()
```
    Get chain stats of current node.
    
    Returns:
    
    a chain stats
  - listPeers
```
java.util.List<Peer> listPeers()
```
    Get blockchain peer addresses filtering hidden peers and itself.
    
    Returns:
    
    peer addresses
  - listPeers
```
java.util.List<Peer> listPeers(boolean showHidden,
                               boolean showSelf)
```
    Get blockchain peer addresses.
    
    Parameters:
    
    showHidden - whether to show hidden peers
    
    showSelf - whether to show node which receives request itself
    
    Returns:
    
    peer addresses
  - listPeerMetrics
```
java.util.List<PeerMetric> listPeerMetrics()
```
    Get metrics of peers.
    
    Returns:
    
    peer metrics
  - getServerInfo
```
ServerInfo getServerInfo(java.util.List<java.lang.String> categories)
```
    Get server info of current node.
    
    Parameters:
    
    categories - a categories
    
    Returns:
    
    server info
  - getNodeStatus
```
NodeStatus getNodeStatus()
```
    Get status of current node.
    
    Returns:
    
    node status
  - getBlockMetadata
```
BlockMetadata getBlockMetadata(BlockHash blockHash)
```
    Get block metadata by hash.
    
    Parameters:
    
    blockHash - block hash
    
    Returns:
    
    block
  - getBlockMetadata
```
BlockMetadata getBlockMetadata(long height)
```
    Get block metadata by height.
    
    Parameters:
    
    height - block's height
    
    Returns:
    
    block
  - listBlockMetadatas
```
java.util.List<BlockMetadata> listBlockMetadatas(BlockHash blockHash,
                                                 int size)
```
    Get block metadatas of size backward starting from block for provided hash.
    
    Parameters:
    
    blockHash - block hash
    
    size - block list size whose upper bound is 1000
    
    Returns:
    
    block list
  - listBlockMetadatas
```
java.util.List<BlockMetadata> listBlockMetadatas(long height,
                                                 int size)
```
    Get block metadatas of size backward starting from block for provided height.
    
    Parameters:
    
    height - block's height
    
    size - block list size whose upper bound is 1000
    
    Returns:
    
    block list
  - getBlock
```
Block getBlock(BlockHash blockHash)
```
    Get block by hash.
    
    Parameters:
    
    blockHash - block hash
    
    Returns:
    
    block
  - getBlock
```
Block getBlock(long height)
```
    Get block by height.
    
    Parameters:
    
    height - block's height
    
    Returns:
    
    block
  - subscribeNewBlockMetadata
```
Subscription<BlockMetadata> subscribeNewBlockMetadata(StreamObserver<BlockMetadata> observer)
```
    Subscribe block metadata stream which is triggered everytime new block is generated.
    
    Parameters:
    
    observer - a stream observer which is invoked on new block metadata
    
    Returns:
    
    a block subscription
  - subscribeNewBlock
```
Subscription<Block> subscribeNewBlock(StreamObserver<Block> observer)
```
    Subscribe block stream which is triggered everytime new block is generated.
    
    Parameters:
    
    observer - a stream observer which is invoked on new block
    
    Returns:
    
    a block subscription
  - getTransaction
```
Transaction getTransaction(TxHash txHash)
```
    Get transaction.
    
    Parameters:
    
    txHash - transaction's hash
    
    Returns:
    
    transaction
  - getReceipt
```
ContractTxReceipt getReceipt(ContractTxHash contractTxHash)
```
    Get receipt of transaction.
    
    Parameters:
    
    contractTxHash - contract transaction hash
    
    Returns:
    
    receipt of transaction
  - getContractInterface
```
ContractInterface getContractInterface(ContractAddress contractAddress)
```
    Get smart contract interface corresponding to contract address.
    
    Parameters:
    
    contractAddress - contract address
    
    Returns:
    
    contract interface
  - query
```
ContractResult query(ContractInvocation contractInvocation)
```
    Query the smart contract state by calling smart contract function.
    
    Parameters:
    
    contractInvocation - a contract invocation
    
    Returns:
    
    contract result
  - listEvents
```
java.util.List<Event> listEvents(EventFilter filter)
```
    List events corresponding with event filter.
    
    Parameters:
    
    filter - an event filter
    
    Returns:
    
    event list
  - subscribeEvent
```
Subscription<Event> subscribeEvent(EventFilter filter,
                                   StreamObserver<Event> observer)
```
    Subscribe event corresponding with event filter.
    
    Parameters:
    
    filter - an event filter
    
    observer - a stream observer which is invoked on event
    
    Returns:
    
    a subscription

Interface QueryApi

Method Summary

Method Detail

getAccountState

getNameOwner

getNameOwner

getStakingInfo

listElectedBps

listElected

getVotesOf

listServerKeyStoreAccounts

getBestBlockHash

getBestBlockHeight

getChainIdHash

getBlockchainStatus

getChainInfo

getChainStats

listPeers

listPeers

listPeerMetrics

getServerInfo

getNodeStatus

getBlockMetadata

getBlockMetadata

listBlockMetadatas

listBlockMetadatas

getBlock

getBlock

subscribeNewBlockMetadata

subscribeNewBlock

getTransaction

getReceipt

getContractInterface

query

listEvents

subscribeEvent