2018-06-20 17:35:30 -07:00
|
|
|
# Tendermint
|
2019-07-19 19:29:33 +02:00
|
|
|
|
2019-06-29 03:06:44 -04:00
|
|
|
|
2017-04-08 17:07:02 -07:00
|
|
|
|
2018-06-20 17:35:30 -07:00
|
|
|
[Byzantine-Fault Tolerant](https://en.wikipedia.org/wiki/Byzantine_fault_tolerance)
|
2019-01-11 08:28:29 -05:00
|
|
|
[State Machines](https://en.wikipedia.org/wiki/State_machine_replication).
|
2019-07-19 19:29:33 +02:00
|
|
|
Or [Blockchain](<https://en.wikipedia.org/wiki/Blockchain_(database)>), for short.
|
2017-04-08 17:07:02 -07:00
|
|
|
|
2018-06-20 17:35:30 -07:00
|
|
|
[](https://github.com/tendermint/tendermint/releases/latest)
|
2019-07-19 19:29:33 +02:00
|
|
|
[](https://godoc.org/github.com/tendermint/tendermint)
|
2019-03-05 08:08:52 +01:00
|
|
|
[](https://github.com/moovweb/gvm)
|
2018-06-20 17:35:30 -07:00
|
|
|
[](https://riot.im/app/#/room/#tendermint:matrix.org)
|
|
|
|
|
[](https://github.com/tendermint/tendermint/blob/master/LICENSE)
|
|
|
|
|
[](https://github.com/tendermint/tendermint)
|
2018-03-26 10:59:10 +02:00
|
|
|
|
2019-07-19 19:29:33 +02:00
|
|
|
| Branch | Tests | Coverage |
|
|
|
|
|
| ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
|
|
|
|
|
| master | [](https://circleci.com/gh/tendermint/tendermint/tree/master) | [](https://codecov.io/gh/tendermint/tendermint) |
|
2018-05-09 13:48:21 -07:00
|
|
|
|
2018-06-20 17:35:30 -07:00
|
|
|
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.
|
2018-05-09 13:48:21 -07:00
|
|
|
|
2018-09-20 11:55:36 -04:00
|
|
|
For protocol details, see [the specification](/docs/spec).
|
|
|
|
|
|
|
|
|
|
For detailed analysis of the consensus protocol, including safety and liveness proofs,
|
|
|
|
|
see our recent paper, "[The latest gossip on BFT consensus](https://arxiv.org/abs/1807.04938)".
|
2018-03-26 10:59:10 +02:00
|
|
|
|
2019-06-21 22:29:16 +02:00
|
|
|
## Releases
|
2018-03-26 10:59:10 +02:00
|
|
|
|
2019-06-21 22:29:16 +02:00
|
|
|
NOTE: The master branch is now an active development branch (starting with `v0.32`). Please, do not depend on it and
|
|
|
|
|
use [releases](https://github.com/tendermint/tendermint/releases) instead.
|
|
|
|
|
|
|
|
|
|
Tendermint is being used in production in both private and public environments,
|
|
|
|
|
most notably the blockchains of the [Cosmos Network](https://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](#versioning).
|
2018-06-20 17:35:30 -07:00
|
|
|
|
|
|
|
|
In any case, if you intend to run Tendermint in production,
|
2018-10-29 10:13:11 -04:00
|
|
|
please [contact us](mailto:partners@tendermint.com) and [join the chat](https://riot.im/app/#/room/#tendermint:matrix.org).
|
2018-06-20 17:35:30 -07:00
|
|
|
|
|
|
|
|
## Security
|
|
|
|
|
|
|
|
|
|
To report a security vulnerability, see our [bug bounty
|
2018-11-15 12:04:47 -05:00
|
|
|
program](https://hackerone.com/tendermint)
|
2018-06-20 17:35:30 -07:00
|
|
|
|
|
|
|
|
For examples of the kinds of bugs we're looking for, see [SECURITY.md](SECURITY.md)
|
|
|
|
|
|
|
|
|
|
## Minimum requirements
|
|
|
|
|
|
2019-07-19 19:29:33 +02:00
|
|
|
| Requirement | Notes |
|
|
|
|
|
| ----------- | ------------------ |
|
|
|
|
|
| Go version | Go1.11.4 or higher |
|
2018-06-20 17:35:30 -07:00
|
|
|
|
2018-11-15 12:04:47 -05:00
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
Complete documentation can be found on the [website](https://tendermint.com/docs/).
|
|
|
|
|
|
|
|
|
|
### Install
|
2018-06-20 17:35:30 -07:00
|
|
|
|
2018-07-17 15:44:59 +09:00
|
|
|
See the [install instructions](/docs/introduction/install.md)
|
2018-06-20 17:35:30 -07:00
|
|
|
|
2018-11-15 12:04:47 -05:00
|
|
|
### Quick Start
|
2018-06-20 17:35:30 -07:00
|
|
|
|
2018-11-15 12:04:47 -05:00
|
|
|
- [Single node](/docs/introduction/quick-start.md)
|
|
|
|
|
- [Local cluster using docker-compose](/docs/networks/docker-compose.md)
|
2018-07-17 15:49:38 +09:00
|
|
|
- [Remote cluster using terraform and ansible](/docs/networks/terraform-and-ansible.md)
|
2018-09-08 08:45:12 -04:00
|
|
|
- [Join the Cosmos testnet](https://cosmos.network/testnet)
|
2018-06-20 17:35:30 -07:00
|
|
|
|
2019-01-11 08:28:29 -05:00
|
|
|
## Contributing
|
2018-06-20 17:35:30 -07:00
|
|
|
|
2019-01-11 08:28:29 -05:00
|
|
|
Please abide by the [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions,
|
|
|
|
|
and the [contributing guidelines](CONTRIBUTING.md) when submitting code.
|
2018-06-20 17:35:30 -07:00
|
|
|
|
2019-01-11 08:28:29 -05:00
|
|
|
Join the larger community on the [forum](https://forum.cosmos.network/) and the [chat](https://riot.im/app/#/room/#tendermint:matrix.org).
|
2018-06-20 17:35:30 -07:00
|
|
|
|
2019-01-11 08:28:29 -05:00
|
|
|
To learn more about the structure of the software, watch the [Developer
|
2019-09-03 11:59:13 +04:00
|
|
|
Sessions](/docs/DEV_SESSIONS.md) and read some [Architectural Decision
|
|
|
|
|
Records](https://github.com/tendermint/tendermint/tree/master/docs/architecture).
|
2018-06-20 17:35:30 -07:00
|
|
|
|
2019-01-11 08:28:29 -05:00
|
|
|
Learn more by reading the code and comparing it to the
|
2019-09-27 15:16:19 -07:00
|
|
|
[specification](https://github.com/tendermint/tendermint/tree/master/docs/spec).
|
2018-06-20 17:35:30 -07:00
|
|
|
|
|
|
|
|
## Versioning
|
|
|
|
|
|
2019-01-11 08:28:29 -05:00
|
|
|
### Semantic Versioning
|
2018-06-20 17:35:30 -07:00
|
|
|
|
2019-01-11 08:28:29 -05:00
|
|
|
Tendermint uses [Semantic Versioning](http://semver.org/) to determine when and how the version changes.
|
2018-06-20 17:35:30 -07:00
|
|
|
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:
|
|
|
|
|
|
2019-02-07 20:12:57 -05:00
|
|
|
- crypto
|
2018-06-20 17:35:30 -07:00
|
|
|
- types
|
|
|
|
|
- rpc/client
|
|
|
|
|
- config
|
|
|
|
|
- node
|
2018-09-28 23:32:13 -04:00
|
|
|
- libs
|
|
|
|
|
- bech32
|
|
|
|
|
- common
|
|
|
|
|
- db
|
|
|
|
|
- errors
|
|
|
|
|
- log
|
2018-06-20 17:35:30 -07:00
|
|
|
|
|
|
|
|
Exported objects in these packages that are not covered by the versioning scheme
|
2018-07-02 14:20:27 -04:00
|
|
|
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.
|
2018-06-20 17:35:30 -07:00
|
|
|
|
|
|
|
|
### 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](https://github.com/tendermint/tendermint/issues)).
|
|
|
|
|
|
2019-01-11 08:28:29 -05:00
|
|
|
For more information on upgrading, see [UPGRADING.md](./UPGRADING.md)
|
2018-09-08 08:45:12 -04:00
|
|
|
|
2019-01-11 08:28:29 -05:00
|
|
|
## Resources
|
|
|
|
|
|
|
|
|
|
### Tendermint Core
|
|
|
|
|
|
|
|
|
|
For details about the blockchain data structures and the p2p protocols, see the
|
|
|
|
|
[Tendermint specification](/docs/spec).
|
|
|
|
|
|
|
|
|
|
For details on using the software, see the [documentation](/docs/) which is also
|
|
|
|
|
hosted at: https://tendermint.com/docs/
|
|
|
|
|
|
|
|
|
|
### Tools
|
|
|
|
|
|
|
|
|
|
Benchmarking and monitoring is provided by `tm-bench` and `tm-monitor`, respectively.
|
|
|
|
|
Their code is found [here](/tools) and these binaries need to be built seperately.
|
|
|
|
|
Additional documentation is found [here](/docs/tools).
|
|
|
|
|
|
|
|
|
|
### Sub-projects
|
|
|
|
|
|
2019-07-19 19:29:33 +02:00
|
|
|
- [Amino](http://github.com/tendermint/go-amino), reflection-based proto3, with
|
2019-01-11 08:28:29 -05:00
|
|
|
interfaces
|
2019-07-19 19:29:33 +02:00
|
|
|
- [IAVL](http://github.com/tendermint/iavl), Merkleized IAVL+ Tree implementation
|
|
|
|
|
- [Tm-cmn](http://github.com/tendermint/tm-cmn), Commonly used libs across Tendermint & Cosmos repos
|
2019-01-11 08:28:29 -05:00
|
|
|
|
|
|
|
|
### Applications
|
|
|
|
|
|
2019-07-19 19:29:33 +02:00
|
|
|
- [Cosmos SDK](http://github.com/cosmos/cosmos-sdk); a cryptocurrency application framework
|
|
|
|
|
- [Ethermint](http://github.com/cosmos/ethermint); Ethereum on Tendermint
|
|
|
|
|
- [Many more](https://tendermint.com/ecosystem)
|
2019-01-11 08:28:29 -05:00
|
|
|
|
|
|
|
|
### Research
|
|
|
|
|
|
2019-07-19 19:29:33 +02:00
|
|
|
- [The latest gossip on BFT consensus](https://arxiv.org/abs/1807.04938)
|
|
|
|
|
- [Master's Thesis on Tendermint](https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769)
|
|
|
|
|
- [Original Whitepaper](https://tendermint.com/static/docs/tendermint.pdf)
|
|
|
|
|
- [Blog](https://blog.cosmos.network/tendermint/home)
|
