README.md

Greenfield CometBFT

Greenfield CometBFT, forked from CometBFT, is the consensus layer of Greenfield blockchain. 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.

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

Disclaimer

The software and related documentation are under active development, all subject to potential future change without notification and not ready for production use. The code and security audit have not been fully completed and not ready for any bug bounty. We advise you to be careful and experiment on the network at your own risk. Stay safe out there.

Key features

We implement several key features based on the CometBFT fork:

• Vote Pool. Vote pool is used to collect votes from different validators for off-chain consensus. Currently, it is mainly used for cross chain and data availability challenge in Greenfield blockchain.
• RANDAO. RANDAO is introduced for on-chain randomness. Overall, the idea is very similar to the RANDAO in Ethereum beacon chain, you can refer to here for more information. It has some limitations, please use it with caution.

Minimum requirements

Requirement	Notes
Go version	Go 1.20 or higher

Install

See the install guide.

Quick Start

• Single node
• Local cluster using docker-compose

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

Resources

Libraries

• Cosmos SDK; A framework for building applications in Golang
• Tendermint in Rust
• ABCI Tower

Applications

• Cosmos Hub
• Terra
• Celestia
• Anoma
• Vocdoni

Research

• The latest gossip on BFT consensus
• Master's Thesis on Tendermint
• Original Whitepaper: "Tendermint: Consensus Without Mining"

License

The Greenfield CometBFT library (i.e. all code outside the cmd directory) is licensed under the GNU Lesser General Public License v3.0, also included in our repository in the COPYING.LESSER file.

The Greenfield CometBFT binaries (i.e. all code inside the cmd directory) is licensed under the GNU General Public License v3.0, also included in our repository in the COPYING file.