Categorygithub.com/reapchain/reapchain-corerpccore
package
0.34.20-reap.core.v0.1.14-rc8
Repository: https://github.com/reapchain/reapchain-core.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
29
Dependents
4
Files
1.3k SLOC

# README

ReapchainCore RPC

Pagination

Requests that return multiple items will be paginated to 30 items by default. You can specify further pages with the ?page parameter. You can also set a custom page size up to 100 with the ?per_page parameter.

Subscribing to events

The user can subscribe to events emitted by ReapchainCore, using /subscribe. If the maximum number of clients is reached or the client has too many subscriptions, an error will be returned. The subscription timeout is 5 sec. Each subscription has a buffer to accommodate short bursts of events or some slowness in clients. If the buffer gets full, the subscription will be canceled ("client is not pulling messages fast enough"). If ReapchainCore exits, all subscriptions are canceled ("ReapchainCore exited"). The user can unsubscribe using either /unsubscribe or /unsubscribe_all.

# Packages

No description provided by the author

# Functions

ABCIInfo gets some info about the application.
ABCIQuery queries the application for some information.
AddUnsafeRoutes adds unsafe routes.
Block gets block at a given height.
BlockByHash gets block by hash.
BlockchainInfo gets block headers for minHeight <= height <= maxHeight.
BlockResults gets ABCIResults at a given height.
BlockSearch searches for a paginated set of blocks matching BeginBlock and EndBlock event search criteria.
BroadcastEvidence broadcasts evidence of the misbehavior.
BroadcastTxAsync returns right away, with no response.
BroadcastTxCommit returns with the responses from CheckTx and DeliverTx.
BroadcastTxSync returns with the response from CheckTx.
CheckTx checks the transaction without executing it.
Commit gets block commit at a given height.
ConsensusParams gets the consensus parameters at the given block height.
ConsensusState returns a concise summary of the consensus state.
DumpConsensusState dumps consensus state.
Genesis returns genesis file.
No description provided by the author
Health gets node health.
InitGenesisChunks configures the environment and should be called on service startup.
NetInfo returns network info.
NextQrns gets the next consensus round qrn set at the given block height.
NextVrfs gets the next consensus round vrf set at the given block height.
NumUnconfirmedTxs gets number of unconfirmed transactions.
Qrns gets the qrn set at the given block height.
SetEnvironment sets up the given Environment.
SettingSteeringMember gets the steerin member list to be applied next consensus round at the given block height.
No description provided by the author
Status returns ReapchainCore status including node info, pubkey, latest block hash, app hash, block height and time.
SteeringMemberCandidates gets the steering memeber candiate set at the given block height.
Subscribe for events via WebSocket.
Tx allows you to query the transaction results.
TxSearch allows you to query for multiple transactions results.
UnconfirmedTxs gets unconfirmed transactions (maximum ?limit entries) including their number.
UnsafeDialPeers dials the given peers (comma-separated id@IP:PORT), optionally making them persistent.
UnsafeDialSeeds dials the given seeds (comma-separated id@IP:PORT).
UnsafeFlushMempool removes all transactions from the mempool.
Unsubscribe from events via WebSocket.
UnsubscribeAll from all events via WebSocket.
Validators gets the validator set at the given block height.
Vrf gets the vrf set at the given block height.

# Constants

SubscribeTimeout is the maximum time we wait to subscribe for an event.

# Variables

Routes is a map of available routes.

# Structs

---------------------------------------------- Environment contains objects and interfaces used by the RPC.

# Interfaces

No description provided by the author