Skip to content

CometBFT (fork of Tendermint Core): A distributed, Byzantine fault-tolerant, deterministic state machine replication engine

License

Notifications You must be signed in to change notification settings

mikebraver/cometbft

This branch is 1213 commits behind cometbft/cometbft:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

037f29d · Aug 14, 2023
Aug 11, 2023
Aug 14, 2023
Feb 28, 2023
Aug 14, 2023
Aug 3, 2023
Jul 27, 2023
Aug 7, 2023
Aug 14, 2023
Apr 13, 2023
Jul 19, 2023
Aug 14, 2023
Aug 3, 2023
Aug 4, 2023
Aug 14, 2023
Aug 14, 2023
Aug 10, 2023
Feb 1, 2023
Aug 8, 2023
Jul 14, 2023
Aug 14, 2023
Aug 3, 2023
Jul 24, 2023
Jul 25, 2023
Jun 2, 2023
Aug 11, 2023
Aug 7, 2023
Jun 26, 2023
Aug 14, 2023
Aug 7, 2023
Sep 6, 2022
Feb 1, 2023
Aug 14, 2023
Mar 29, 2023
Sep 22, 2020
Oct 22, 2020
Dec 4, 2017
Feb 1, 2023
Jun 5, 2023
Feb 10, 2023
Jul 29, 2022
Oct 19, 2020
Oct 31, 2022
Jun 15, 2023
Feb 1, 2023
Apr 25, 2023
Aug 19, 2022
Apr 12, 2023
Mar 28, 2023
Jun 26, 2023
Apr 7, 2023
Jan 25, 2023
Jul 27, 2023
Sep 6, 2022
Jun 23, 2022
Feb 17, 2023
May 26, 2023
Jan 16, 2023
Aug 21, 2020
Aug 14, 2023
Aug 14, 2023
Feb 1, 2023

Repository files navigation

CometBFT

Byzantine-Fault Tolerant State Machine Replication. Or Blockchain, for short.

Version API Reference Go version Discord chat License Sourcegraph

Branch Tests Linting
main Tests Lint
v0.38.x Tests Lint
v0.37.x Tests Lint
v0.34.x Tests Lint

CometBFT 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.

It is a fork of Tendermint Core and implements the Tendermint consensus algorithm.

For protocol details, refer to the CometBFT Specification.

For detailed analysis of the consensus protocol, including safety and liveness proofs, read our paper, "The latest gossip on BFT consensus".

Documentation

Complete documentation can be found on the website.

Releases

Please do not depend on main as your production branch. Use releases instead.

We haven't released v1.0 yet since we are making breaking changes to the protocol and the APIs. See below for more details about versioning.

In any case, if you intend to run CometBFT in production, we're happy to help.

To contact us, you can also join the chat.

More on how releases are conducted can be found here.

Security

To report a security vulnerability, see our bug bounty program. For examples of the kinds of bugs we're looking for, see our security policy.

Minimum requirements

CometBFT version Requirement Notes
main Go version Go 1.20 or higher
v0.38.x Go version Go 1.20 or higher
v0.37.x Go version Go 1.20 or higher
v0.34.x Go version Go 1.19 or higher

Install

See the install guide.

Quick Start

Contributing

Please abide by the Code of Conduct in all interactions.

Before contributing to the project, please take a look at the contributing guidelines and the style guide. You may also find it helpful to read the specifications, and familiarize yourself with our Architectural Decision Records (ADRs) and Request For Comments (RFCs).

Versioning

Semantic Versioning

CometBFT uses Semantic Versioning to determine when and how the version changes. According to SemVer, anything in the public API can change at any time before version 1.0.0

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 prior to 1.0.0, 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

Because we are a small core team, we have limited capacity to ship patch updates, including security updates. Consequently, we strongly recommend keeping CometBFT up-to-date. Upgrading instructions can be found in UPGRADING.md.

Currently supported versions include:

  • v0.38.x: CometBFT v0.38 introduces ABCI 2.0, which implements the entirety of ABCI++
  • v0.37.x: CometBFT v0.37 introduces ABCI 1.0, which is the first major step towards the full ABCI++ implementation in ABCI 2.0
  • v0.34.x: The CometBFT v0.34 series is compatible with the Tendermint Core v0.34 series

Resources

Libraries

Applications

Research

Below are links to the original Tendermint consensus algorithm and relevant whitepapers which CometBFT will continue to build on.

Join us

CometBFT is currently maintained by Informal Systems. If you'd like to work full-time on CometBFT, we're hiring!

Funding for CometBFT development comes primarily from the Interchain Foundation, a Swiss non-profit. Informal Systems also maintains cometbft.com.

About

CometBFT (fork of Tendermint Core): A distributed, Byzantine fault-tolerant, deterministic state machine replication engine

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 84.2%
  • TeX 7.8%
  • TLA 5.8%
  • Bluespec 0.6%
  • Python 0.6%
  • Shell 0.5%
  • Other 0.5%