tendermint/README.md

Tendermint

Byzantine-Fault Tolerant State Machines. Or Blockchain, for short.

Branch	Tests	Coverage	Linting
master

Tendermint Core is 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, see the specification.

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

Releases

NOTE: The master branch is now an active development branch (starting with v0.32). Please, do not depend on it and use releases instead.

Tendermint is being used in production in both private and public environments, most notably the blockchains of the Cosmos Network. However, we are still making breaking changes to the protocol and the APIs and have not yet released v1.0. See below for more details about versioning.

In any case, if you intend to run Tendermint in production, please contact us and join the chat.

Security

To report a security vulnerability, see our bug bounty program

For examples of the kinds of bugs we're looking for, see SECURITY.md

Minimum requirements

Requirement	Notes
Go version	Go1.13 or higher

Documentation

Complete documentation can be found on the website.

Install

See the install instructions

Quick Start

• Single node
• Local cluster using docker-compose
• Remote cluster using terraform and ansible
• Join the Cosmos testnet

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.

To get more active, Join the wider community at Discord or jump onto the Forum.

Learn more by reading the code and the specifications or watch the Developer Sessions and read up on the Architectural Decision Records.

Versioning

Semantic Versioning

Tendermint 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 Tendermint users in these 0.X.X days, the MINOR version is used to signal breaking changes across a subset of the total public API. This subset includes all interfaces exposed to other processes (cli, rpc, p2p, etc.), but does not include the in-process Go APIs.

That said, breaking changes in the following packages will be documented in the CHANGELOG even if they don't lead to MINOR version bumps:

• crypto
• types
• rpc/client
• config
• node
• libs
  • bech32
  • common
  • db
  • errors
  • log

Exported objects in these packages that are not covered by the versioning scheme are explicitly marked by // UNSTABLE in their go doc comment and may change at any time without notice. Functions, types, and values in any other package may also change at any time.

Upgrades

In an effort to avoid accumulating technical debt prior to 1.0.0, we do not guarantee that breaking changes (ie. bumps in the MINOR version) will work with existing tendermint 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 histories (if not please open an issue).

For more information on upgrading, see UPGRADING.md.

Supported Versions

Because we are a small core team, we only ship patch updates, including security updates, to the most recent minor release and the second-most recent minor release. Consequently, we strongly recommend keeping Tendermint up-to-date. Upgrading instructions can be found in UPGRADING.md.

Resources

Tendermint Core

For details about the blockchain data structures and the p2p protocols, see the Tendermint specification.

For details on using the software, see the documentation which is also hosted at: https://docs.tendermint.com/master/

Tools

Benchmarking is provided by tm-load-test. The code for tm-load-test can be found here this binary needs to be built separately. Additional documentation is found here.

Sub-projects

• Amino, reflection-based proto3, with interfaces
• IAVL, Merkleized IAVL+ Tree implementation
• Tm-db, Data Base abstractions to be used in applications.

Applications

• Cosmos SDK; a cryptocurrency application framework
• Ethermint; Ethereum on Tendermint
• Many more

Research

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