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".
A Note on Production Readiness
While Tendermint is being used in production in private, permissioned environments, we are still working actively to harden and audit it in preparation for use in public blockchains, such as the Cosmos Network. We are also still making breaking changes to the protocol and the APIs. Thus, we tag the releases as alpha software.
To report a security vulnerability, see our bug bounty program
For examples of the kinds of bugs we're looking for, see SECURITY.md
|Go version||Go1.11.4 or higher|
Complete documentation can be found on the website.
See the install instructions
- Single node
- Local cluster using docker-compose
- Remote cluster using terraform and ansible
- Join the Cosmos testnet
Learn more by reading the code and comparing it to the specification.
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:
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.
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
For details about the blockchain data structures and the p2p protocols, see the Tendermint specification.
|benchmarks/proto||Package test is a generated protocol buffer package.|
|crypto/merkle||Package merkle computes a deterministic minimal height Merkle tree hash.|
|crypto/secp256k1/internal/secp256k1||Package secp256k1 wraps the bitcoin secp256k1 C library.|
|crypto/xchacha20poly1305||Package xchacha20poly1305 creates an AEAD using hchacha, chacha, and poly1305 This allows for randomized nonces to be used in conjunction with chacha.|
|libs/db/remotedb||remotedb is a package for connecting to distributed Tendermint db.DB instances.|
|libs/db/remotedb/grpcdb||grpcdb is the distribution of Tendermint's db.DB instances using the gRPC transport to decouple local db.DB usages from applications, to using them over a network in a highly performant manner.|
|libs/db/remotedb/proto||Package protodb is a generated protocol buffer package.|
|libs/errors||Package errors contains errors that are thrown across packages.|
|libs/events||Package events - Pub-Sub in go with event caching|
|libs/flowrate||Package flowrate provides the tools for monitoring and limiting the flow rate of an arbitrary data stream.|
|libs/pubsub||Package pubsub implements a pub-sub model with a single publisher (Server) and multiple subscribers (clients).|
|libs/pubsub/query||Package query provides a parser for a custom query format: abci.invoice.number=22 AND abci.invoice.owner=Ivan See query.peg for the grammar, which is a https://en.wikipedia.org/wiki/Parsing_expression_grammar.|
|lite||Package lite allows you to securely validate headers without a full node.|
|lite/client||Package client defines a provider that uses a rpcclient to get information, which is used to get new headers and validators directly from a Tendermint client.|
|p2p/upnp||Taken from taipei-torrent.|
|privval||Package privval provides different implementations of the types.PrivValidator.|
|rpc/core||# Introduction Tendermint supports the following RPC protocols: * URI over HTTP * JSONRPC over HTTP * JSONRPC over websockets Tendermint RPC is built using our own RPC library which contains its own set of documentation and tests.|
|rpc/lib||HTTP RPC server supporting calls via uri params, jsonrpc, and jsonrpc over websockets Client Requests Suppose we want to expose the rpc function `HelloWorld(name string, num int)`.|
|rpc/lib/server||Commons for HTTP handling|
|tools/tm-monitor/eventmeter||eventmeter - generic system to subscribe to events and record their frequency.|