The highest tagged major version is
README
¶
CometBFT
CometBFT is the most widely-adopted, battle-tested consensus engine in blockchain today. It is a Byzantine Fault Tolerant (BFT) middleware that takes a state transition machine - written in any programming language - and securely replicates it on many machines.
CometBFT is highly performant and achieves speeds of up to 10k transactions per second (TPS). Its flagship feature, ABCI++ enables developers to add programmability and customization to every step of the consensus engine.
Developers can use CometBFT for BFT state machine replication of applications written in any programming language and development environment. This modularity gives developers flexibility to choose tools and technologies best suited for specific projects, improves maintainability, and delivers the scalability required for large-scale decentralized applications.
CometBFT is a fork of Tendermint Core and implements the Tendermint consensus algorithm.
Releases
Please do not depend on main as your production branch. Use releases instead.
More on how releases are conducted can be found here.
Minimum requirements
| CometBFT version | Requirement | Notes |
|---|---|---|
| main | Go version | Go 1.23 or higher |
| v0.38.x | Go version | Go 1.22 or higher |
Install
See the install guide.
Quick Start
Versioning
Semantic Versioning
CometBFT uses Semantic Versioning to determine when and how the version changes.
To provide some stability to users of 0.X.X versions of CometBFT, the MINOR version is used to signal breaking changes across CometBFT's API. This API includes all publicly exposed types, functions, and methods in non-internal Go packages as well as the types and methods accessible via the CometBFT RPC interface.
Breaking changes to these public APIs will be documented in the CHANGELOG.
Upgrades
In an effort to avoid accumulating technical debt, we do not guarantee that breaking changes (i.e. bumps in the MINOR version) will work with existing CometBFT blockchains. In these cases you will have to start a new blockchain, or write something custom to get the old data into the new chain. However, any bump in the PATCH version should be compatible with existing blockchain histories.
For more information on upgrading, see UPGRADING.md.
Supported Versions
Currently supported versions include:
- v0.38.x: CometBFT v0.38 introduces ABCI 2.0, which implements the entirety of ABCI++
Developer Community and Support
The issue list of this repo is exclusively for bug reports and feature requests. We have active, helpful communities on Discord, Telegram, and Slack.
| Need Help? | Support & Community: Discord - Telegram - Talk to an Expert - Join the #Cosmos-tech Slack Channel |
Security
To report a security vulnerability, see the Cosmos bug bounty program. For examples of the kinds of bugs we're looking for, see our security policy.
Maintainers
Cosmos Labs maintains the core components of the stack: Cosmos SDK, CometBFT, IBC, Cosmos EVM, and various developer tools and frameworks. The detailed maintenance policy can be found here. In addition to developing and maintaining the Cosmos Stack, Cosmos Labs provides advisory and engineering services for blockchain solutions. Get in touch with Cosmos Labs.
Cosmos Labs is a wholly-owned subsidiary of the Interchain Foundation, the Swiss nonprofit responsible for treasury management, funding public goods, and supporting governance for Cosmos.
The Cosmos Stack is supported by a robust community of open-source contributors.
Contributing
If you are interested in working on an issue, please comment on it, and take a look at the contributing guidelines. We welcome and appreciate community contributions!
Documentation and Resources
Documentation
Cosmos Stack Libraries
- Cosmos SDK - A framework for building applications in Golang
- The Inter-Blockchain Communication Protocol (IBC) - A blockchain interoperability protocol that allows blockchains to transfer any type of data encoded in bytes.
- Cosmos EVM - Native EVM layer for Cosmos SDK chains.
Research
Below are links to the original Tendermint consensus algorithm and relevant whitepapers which CometBFT will continue to build on.
Directories
¶
| Path | Synopsis |
|---|---|
|
abci
|
|
|
cmd/abci-cli
command
|
|
|
server
Package server is used to start a new ABCI server.
|
Package server is used to start a new ABCI server. |
|
tests/benchmarks/parallel
command
|
|
|
tests/benchmarks/simple
command
|
|
|
api
module
|
|
|
cmd
|
|
|
cometbft
command
|
|
|
contract_tests
command
|
|
|
priv_val_server
command
|
|
|
merkle
Package merkle computes a deterministic minimal height Merkle tree hash.
|
Package merkle computes a deterministic minimal height Merkle tree hash. |
|
xchacha20poly1305
Package xchacha20poly1305 creates an AEAD using hchacha, chacha, and poly1305 This allows for randomized nonces to be used in conjunction with chacha.
|
Package xchacha20poly1305 creates an AEAD using hchacha, chacha, and poly1305 This allows for randomized nonces to be used in conjunction with chacha. |
|
Package evidence handles all evidence storage and gossiping from detection to block proposal.
|
Package evidence handles all evidence storage and gossiping from detection to block proposal. |
|
Package inspect provides a tool for investigating the state of a failed CometBFT node.
|
Package inspect provides a tool for investigating the state of a failed CometBFT node. |
|
internal
|
|
|
test
Package factory provides generation code for common structs in CometBFT.
|
Package factory provides generation code for common structs in CometBFT. |
|
libs
|
|
|
autofile/cmd
command
|
|
|
events
Package events - Pub-Sub in go with event caching
|
Package events - Pub-Sub in go with event caching |
|
flowrate
Package flowrate provides the tools for monitoring and limiting the flow rate of an arbitrary data stream.
|
Package flowrate provides the tools for monitoring and limiting the flow rate of an arbitrary data stream. |
|
json
Package json provides functions for marshaling and unmarshaling JSON in a format that is backwards-compatible with Amino JSON encoding.
|
Package json provides functions for marshaling and unmarshaling JSON in a format that is backwards-compatible with Amino JSON encoding. |
|
pubsub
Package pubsub implements a pub-sub model with a single publisher (Server) and multiple subscribers (clients).
|
Package pubsub implements a pub-sub model with a single publisher (Server) and multiple subscribers (clients). |
|
pubsub/query
Package query implements the custom query format used to filter event subscriptions in CometBFT.
|
Package query implements the custom query format used to filter event subscriptions in CometBFT. |
|
pubsub/query/syntax
Package syntax defines a scanner and parser for the CometBFT event filter query language.
|
Package syntax defines a scanner and parser for the CometBFT event filter query language. |
|
package light provides a light client implementation.
|
package light provides a light client implementation. |
|
TODO: Better handle abci client errors.
|
TODO: Better handle abci client errors. |
|
Package node is the main entry point, where the Node struct, which represents a full node, is defined.
|
Package node is the main entry point, where the Node struct, which represents a full node, is defined. |
|
Package privval provides different implementations of the types.PrivValidator.
|
Package privval provides different implementations of the types.PrivValidator. |
|
proto
|
|
|
rpc
|
|
|
core
Package core defines the CometBFT RPC endpoints.
|
Package core defines the CometBFT RPC endpoints. |
|
jsonrpc
HTTP RPC server supporting calls via uri params, jsonrpc over HTTP, and jsonrpc over websockets
|
HTTP RPC server supporting calls via uri params, jsonrpc over HTTP, and jsonrpc over websockets |
|
jsonrpc/server
Commons for HTTP handling
|
Commons for HTTP handling |
|
jsonrpc/test
command
|
|
|
scripts
|
|
|
json2wal
command
|
|
|
metricsgen
command
metricsgen is a code generation tool for creating constructors for CometBFT metrics types.
|
metricsgen is a code generation tool for creating constructors for CometBFT metrics types. |
|
metricsgen/metricsdiff
command
metricsdiff is a tool for generating a diff between two different files containing prometheus metrics.
|
metricsdiff is a tool for generating a diff between two different files containing prometheus metrics. |
|
wal2json
command
|
|
|
indexer/sink/psql
Package psql implements an event sink backed by a PostgreSQL database.
|
Package psql implements an event sink backed by a PostgreSQL database. |
|
test
|
|
|
app
command
|
|
|
e2e/generator
command
|
|
|
e2e/node
command
|
|
|
e2e/runner
command
|
|
|
loadtime/cmd/load
command
|
|
|
loadtime/cmd/report
command
|
|
|
e2e
module
|
|