README
¶
Tendermint
Byzantine-Fault Tolerant State Machines. Or Blockchain, for short.
| Branch | Tests | Coverage | Linting |
|---|---|---|---|
| master |  |
 |
 |
Tendermint Core 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, 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
Please do not depend on master as your production branch. Use releases instead.
Tendermint has been in the production of private and public environments, most notably the blockchains of the Cosmos Network. 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 Tendermint in production, we're happy to help. You can contact us over email or 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 our security policy.
We also maintain a dedicated mailing list for security updates. We will only ever use this mailing list to notify you of vulnerabilities and fixes in Tendermint Core. You can subscribe here.
Minimum requirements
| Requirement | Notes |
|---|---|
| Go version | Go1.16 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. You may also find it helpful to read the specifications, watch the Developer Sessions, and familiarize yourself with our 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 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
- config
- libs
- bits
- bytes
- json
- log
- math
- net
- os
- protoio
- rand
- sync
- strings
- service
- node
- rpc/client
- types
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 blockchain histories.
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.
Additional tooling can be found in /docs/tools.
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"
- Tendermint Core Blog
- Cosmos Blog
Join us!
Tendermint Core is maintained by Interchain GmbH. If you'd like to work full-time on Tendermint Core, we're hiring!
Funding for Tendermint Core development comes primarily from the Interchain Foundation, a Swiss non-profit. The Tendermint trademark is owned by Tendermint Inc., the for-profit entity that also maintains tendermint.com.
Directories
¶
| Path | Synopsis |
|---|---|
|
abci
|
|
|
client
Package abcicli provides an ABCI implementation in Go.
|
Package abcicli provides an ABCI implementation in Go. |
|
server
Package server is used to start a new ABCI server.
|
Package server is used to start a new ABCI server. |
|
cmd
|
|
|
merkle
Package merkle computes a deterministic minimal height Merkle tree hash.
|
Package merkle computes a deterministic minimal height Merkle tree hash. |
|
internal
|
|
|
blockchain
Package blockchain provides two implementations of the fast-sync protocol.
|
Package blockchain provides two implementations of the fast-sync protocol. |
|
blockchain/v2/internal/behavior
Package Behavior provides a mechanism for reactors to report behavior of peers.
|
Package Behavior provides a mechanism for reactors to report behavior of peers. |
|
evidence
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. |
|
libs/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. |
|
libs/test
nolint:gosec // G404: Use of weak random number generator
|
nolint:gosec // G404: Use of weak random number generator |
|
mempool/v0
TODO: Better handle abci client errors.
|
TODO: Better handle abci client errors. |
|
p2p/pex
Package PEX (Peer exchange) handles all the logic necessary for nodes to share information about their peers to other nodes.
|
Package PEX (Peer exchange) handles all the logic necessary for nodes to share information about their peers to other nodes. |
|
p2p/upnp
Taken from taipei-torrent.
|
Taken from taipei-torrent. |
|
libs
|
|
|
events
Package events - Pub-Sub in go with event caching
|
Package events - Pub-Sub in go with event caching |
|
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 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.
|
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. |
|
package light provides a light client implementation.
|
package light provides a light client implementation. |
|
mbt
Package mbt provides a test runner for model-based tests Model-based tests are generated by https://github.com/informalsystems/tendermint-rs/tree/master/testgen, which first turns TLA+ specifications into test scenarios.
|
Package mbt provides a test runner for model-based tests Model-based tests are generated by https://github.com/informalsystems/tendermint-rs/tree/master/testgen, which first turns TLA+ specifications into test scenarios. |
|
Package node is the main entry point, where the tendermint node service is constructed and the implementation of that service is defined.
|
Package node is the main entry point, where the tendermint node service is constructed and the implementation of that service is defined. |
|
pkg
|
|
|
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 Tendermint RPC endpoints.
|
Package core defines the Tendermint RPC endpoints. |
|
jsonrpc
HTTP RPC server supporting calls via uri params, jsonrpc over HTTP, and jsonrpc over websockets Client Requests Suppose we want to expose the rpc function `HelloWorld(name string, num int)`.
|
HTTP RPC server supporting calls via uri params, jsonrpc over HTTP, and jsonrpc over websockets Client Requests Suppose we want to expose the rpc function `HelloWorld(name string, num int)`. |
|
jsonrpc/server
Commons for HTTP handling
|
Commons for HTTP handling |
|
scripts
|
|
|
keymigrate
Package keymigrate translates all legacy formatted keys to their new components.
|
Package keymigrate translates all legacy formatted keys to their new components. |
|
test
|
|
|
e2e/app
nolint: goconst nolint: gosec nolint: gosec
|
nolint: goconst nolint: gosec nolint: gosec |
|
e2e/generator
nolint: gosec
|
nolint: gosec |
|
e2e/pkg
nolint: gosec
|
nolint: gosec |
|
e2e/runner
nolint: gosec nolint: gosec
|
nolint: gosec nolint: gosec |
|
fuzz/p2p/addrbook
nolint: gosec
|
nolint: gosec |
|
fuzz/p2p/addrbook/init-corpus
nolint: gosec
|
nolint: gosec |
|
fuzz/p2p/pex/init-corpus
nolint: gosec
|
nolint: gosec |
|
fuzz/p2p/secret_connection/init-corpus
nolint: gosec
|
nolint: gosec |
|
tools
|
|