README
¶
Tendermint
Byzantine-Fault Tolerant State Machine Replication. Or Blockchain for short.
| Branch | Tests | Coverage |
|---|---|---|
| master |  |
 |
| develop |  |
 |
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.
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.
In any case, if you intend to run Tendermint in production, please contact us :)
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.9 or higher |
Install
See the install instructions
Quick Start
- Single node
- Local cluster using docker-compose
- Remote cluster using terraform and ansible
- Join the public testnet
Resources
Tendermint Core
For details about the blockchain data structures and the p2p protocols, see the the Tendermint specification.
For details on using the software, Read The Docs. Additional information about some - and eventually all - of the sub-projects below, can be found at Read The Docs.
Sub-projects
- ABCI, the Application Blockchain Interface
- Go-Wire, a deterministic serialization library
- Go-Crypto, an elliptic curve cryptography library
- TmLibs, an assortment of Go libraries used internally
- IAVL, Merkleized IAVL+ Tree implementation
Tools
Applications
- Cosmos SDK; a cryptocurrency application framework
- Ethermint; Ethereum on Tendermint
- Many more
More
Contributing
Yay open source! Please see our contributing guidelines.
Versioning
SemVer
Tendermint uses SemVer 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:
- types
- rpc/client
- config
- node
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.
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).
Code of Conduct
Please read, understand and adhere to our code of conduct.
Directories
¶
| Path | Synopsis |
|---|---|
|
proto
Package test is a generated protocol buffer package.
|
Package test is a generated protocol buffer package. |
|
cmd
|
|
|
docs
|
|
|
libs
|
|
|
events
Pub-Sub in go with event caching
|
Pub-Sub in go with event caching |
|
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:
|
Package query provides a parser for a custom query format: |
|
Package lite allows you to securely validate headers without a full node.
|
Package lite allows you to securely validate headers without a full node. |
|
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 node.
|
Package client defines a provider that uses a rpcclient to get information, which is used to get new headers and validators directly from a node. |
|
files
Package files defines a Provider that stores all data in the filesystem
|
Package files defines a Provider that stores all data in the filesystem |
|
conn
Uses nacl's secret_box to encrypt a net.Conn.
|
Uses nacl's secret_box to encrypt a net.Conn. |
|
upnp
Taken from taipei-torrent.
|
Taken from taipei-torrent. |
|
rpc
|
|
|
client/mock
package mock returns a Client implementation that accepts various (mock) implementations of the various methods.
|
package mock returns a Client implementation that accepts various (mock) implementations of the various methods. |
|
grpc
Package core_grpc is a generated protocol buffer package.
|
Package core_grpc is a generated protocol buffer package. |
|
lib
HTTP RPC server supporting calls via uri params, jsonrpc, and jsonrpc over websockets
|
HTTP RPC server supporting calls via uri params, jsonrpc, and jsonrpc over websockets |
|
lib/server
Commons for HTTP handling
|
Commons for HTTP handling |
|
test
|
|