package
0.0.0-20240305091328-aa4207a4b25d
Repository: https://github.com/badrootd/celestia-core.git
Documentation: pkg.go.dev

# README

CometBFT 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 CometBFT, 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 CometBFT exits, all subscriptions are canceled ("CometBFT 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.
No description provided by the author
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.
DataCommitment collects the data roots over a provided ordered range of blocks, and then creates a new Merkle root of those data roots.
DataRootInclusionProof creates an inclusion proof for the data root of block height `height` in the set of blocks defined by `start` and `end`.
DumpConsensusState dumps consensus state.
EncodeDataRootTuple takes a height and a data root, and returns the equivalent of `abi.encode(...)` in Ethereum.
Genesis returns genesis file.
No description provided by the author
No description provided by the author
Header gets block header at a given height.
HeaderByHash gets header by hash.
Health gets node health.
InitGenesisChunks configures the environment and should be called on service startup.
NetInfo returns network info.
NumUnconfirmedTxs gets number of unconfirmed transactions.
ProveShares creates an NMT proof for a set of shares to a set of rows.
SetEnvironment sets the global environment to e.
SignedBlock fetches the set of transactions at a specified height and all the relevant data to verify the transactions (i.e.
Status returns CometBFT status including node info, pubkey, latest block hash, app hash, block height and time.
Subscribe for events via WebSocket.
To32PaddedHexBytes takes a number and returns its hex representation padded to 32 bytes.
Tx allows you to query the transaction results.
TxSearch allows you to query for multiple transactions results.
TxSearchMatchEvents allows you to query for multiple transactions results and match the query attributes to a common event.
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.

# Constants

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

# Variables

Routes is a map of available routes.

# Structs

DataRootTuple contains the data that will be used to create the QGB commitments.
---------------------------------------------- Environment contains objects and interfaces used by the RPC.

# Interfaces

No description provided by the author