README
¶
Tendermint
Byzantine-Fault Tolerant State Machine Replication. 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, refer to the Tendermint 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 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.
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.
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.17 or higher |
Install
See the install instructions.
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
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 users of 0.X.X versions of Tendermint, the MINOR version is used to signal breaking changes across Tendermint'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 Tendermint 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 (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
Roadmap
We keep a public up-to-date version of our roadmap here
Libraries
- Cosmos SDK; A framework for building applications in Golang
- Tendermint in Rust
- ABCI Tower
Applications
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 abciclient provides an ABCI implementation in Go.
|
Package abciclient provides an ABCI implementation in Go. |
|
cmd/abci-cli
command
|
|
|
server
Package server is used to start a new ABCI server.
|
Package server is used to start a new ABCI server. |
|
tests/benchmarks/parallel
command
|
|
|
tests/benchmarks/simple
command
|
|
|
cmd
|
|
|
contract_tests
command
|
|
|
priv_val_server
command
|
|
|
tendermint
command
|
|
|
merkle
Package merkle computes a deterministic minimal height Merkle tree hash.
|
Package merkle computes a deterministic minimal height Merkle tree hash. |
|
bls
module
|
|
|
internal
|
|
|
blocksync
Package blocksync implements two versions of a reactor Service that are responsible for block propagation and gossip between peers.
|
Package blocksync implements two versions of a reactor Service that are responsible for block propagation and gossip between peers. |
|
eventlog
Package eventlog defines a reverse time-ordered log of events over a sliding window of time before the most recent item in the log.
|
Package eventlog defines a reverse time-ordered log of events over a sliding window of time before the most recent item in the log. |
|
eventlog/cursor
Package cursor implements time-ordered item cursors for an event log.
|
Package cursor implements time-ordered item cursors for an event log. |
|
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. |
|
inspect
Package inspect provides a tool for investigating the state of a failed Tendermint node.
|
Package inspect provides a tool for investigating the state of a failed Tendermint node. |
|
jsontypes
Package jsontypes supports decoding for interface types whose concrete implementations need to be stored as JSON.
|
Package jsontypes supports decoding for interface types whose concrete implementations need to be stored as JSON. |
|
libs/autofile/cmd
command
|
|
|
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/queue
Package queue implements a dynamic FIFO queue with a fixed upper bound and a flexible quota mechanism to handle bursty load.
|
Package queue implements a dynamic FIFO queue with a fixed upper bound and a flexible quota mechanism to handle bursty load. |
|
libs/test
nolint:gosec // G404: Use of weak random number generator
|
nolint:gosec // G404: Use of weak random number generator |
|
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. |
|
pubsub
Package pubsub implements an event dispatching server with a single publisher and multiple subscriber clients.
|
Package pubsub implements an event dispatching server with a single publisher and multiple subscriber clients. |
|
pubsub/query
Package query implements the custom query format used to filter event subscriptions in Tendermint.
|
Package query implements the custom query format used to filter event subscriptions in Tendermint. |
|
pubsub/query/syntax
Package syntax defines a scanner and parser for the Tendermint event filter query language.
|
Package syntax defines a scanner and parser for the Tendermint event filter query language. |
|
rpc/core
Package core defines the Tendermint RPC endpoints.
|
Package core defines the Tendermint RPC endpoints. |
|
state/indexer
Package indexer defines Tendermint's block and transaction event indexing logic.
|
Package indexer defines Tendermint's block and transaction event indexing logic. |
|
state/indexer/sink/psql
Package psql implements an event sink backed by a PostgreSQL database.
|
Package psql implements an event sink backed by a PostgreSQL database. |
|
test/factory
Package factory provides generation code for common structs in Tendermint.
|
Package factory provides generation code for common structs in Tendermint. |
|
libs
|
|
|
events
Package events - Pub-Sub in go with event caching
|
Package events - Pub-Sub in go with event caching |
|
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. |
|
Package privval provides different implementations of the types.PrivValidator.
|
Package privval provides different implementations of the types.PrivValidator. |
|
proto
|
|
|
rpc
|
|
|
client/eventstream
Package eventstream implements a convenience client for the Events method of the Tendermint RPC service, allowing clients to observe a resumable stream of events matching a query.
|
Package eventstream implements a convenience client for the Events method of the Tendermint RPC service, allowing clients to observe a resumable stream of events matching a query. |
|
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 |
|
jsonrpc/test
command
|
|
|
scripts
|
|
|
confix
command
Program confix applies fixes to a Tendermint TOML configuration file to update a file created with an older version of Tendermint to a compatible format for a newer version.
|
Program confix applies fixes to a Tendermint TOML configuration file to update a file created with an older version of Tendermint to a compatible format for a newer version. |
|
confix/condiff
command
Program condiff performs a keyspace diff on two TOML documents.
|
Program condiff performs a keyspace diff on two TOML documents. |
|
estream
command
Program estream is a manual testing tool for polling the event stream of a running Tendermint consensus node.
|
Program estream is a manual testing tool for polling the event stream of a running Tendermint consensus node. |
|
json2wal
command
|
|
|
keymigrate
Package keymigrate translates all legacy formatted keys to their new components.
|
Package keymigrate translates all legacy formatted keys to their new components. |
|
linkpatch
command
Program linkpatch rewrites absolute URLs pointing to targets in GitHub in Markdown link tags to target a different branch.
|
Program linkpatch rewrites absolute URLs pointing to targets in GitHub in Markdown link tags to target a different branch. |
|
metricsgen
command
metricsgen is a code generation tool for creating constructors for Tendermint metrics types.
|
metricsgen is a code generation tool for creating constructors for Tendermint metrics types. |
|
metricsgen/metricsdiff
command
metricsdiff is a tool for generating a diff between two different files containing prometheus metrics.
|
metricsdiff is a tool for generating a diff between two different files containing prometheus metrics. |
|
scmigrate
Package scmigrate implements a migration for SeenCommit data between 0.34 and 0.35 The Migrate implementation is idempotent and finds all seen commit records and deletes all *except* the record corresponding to the highest height.
|
Package scmigrate implements a migration for SeenCommit data between 0.34 and 0.35 The Migrate implementation is idempotent and finds all seen commit records and deletes all *except* the record corresponding to the highest height. |
|
wal2json
command
|
|
|
test
|
|
|
e2e/app
nolint: gosec nolint: gosec
|
nolint: gosec nolint: gosec |
|
e2e/generator
command
nolint: gosec
|
nolint: gosec |
|
e2e/node
command
nolint: goconst
|
nolint: goconst |
|
e2e/pkg
nolint: gosec
|
nolint: gosec |
|
e2e/runner
command
nolint: gosec nolint: gosec
|
nolint: gosec nolint: gosec |