You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

151 lines
8.0 KiB

7 years ago
7 years ago
  1. # Tendermint
  2. ![banner](docs/tendermint-core-image.jpg)
  3. [Byzantine-Fault Tolerant](https://en.wikipedia.org/wiki/Byzantine_fault_tolerance)
  4. [State Machines](https://en.wikipedia.org/wiki/State_machine_replication).
  5. Or [Blockchain](<https://en.wikipedia.org/wiki/Blockchain_(database)>), for short.
  6. [![version](https://img.shields.io/github/tag/tendermint/tendermint.svg)](https://github.com/tendermint/tendermint/releases/latest)
  7. [![API Reference](https://camo.githubusercontent.com/915b7be44ada53c290eb157634330494ebe3e30a/68747470733a2f2f676f646f632e6f72672f6769746875622e636f6d2f676f6c616e672f6764646f3f7374617475732e737667)](https://pkg.go.dev/github.com/tendermint/tendermint)
  8. [![Go version](https://img.shields.io/badge/go-1.16-blue.svg)](https://github.com/moovweb/gvm)
  9. [![Discord chat](https://img.shields.io/discord/669268347736686612.svg)](https://discord.gg/cosmosnetwork)
  10. [![license](https://img.shields.io/github/license/tendermint/tendermint.svg)](https://github.com/tendermint/tendermint/blob/master/LICENSE)
  11. [![tendermint/tendermint](https://tokei.rs/b1/github/tendermint/tendermint?category=lines)](https://github.com/tendermint/tendermint)
  12. [![Sourcegraph](https://sourcegraph.com/github.com/tendermint/tendermint/-/badge.svg)](https://sourcegraph.com/github.com/tendermint/tendermint?badge)
  13. | Branch | Tests | Coverage | Linting |
  14. |--------|--------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|
  15. | master | ![Tests](https://github.com/tendermint/tendermint/workflows/Tests/badge.svg?branch=master) | [![codecov](https://codecov.io/gh/tendermint/tendermint/branch/master/graph/badge.svg)](https://codecov.io/gh/tendermint/tendermint) | ![Lint](https://github.com/tendermint/tendermint/workflows/Lint/badge.svg) |
  16. 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.
  17. For protocol details, see [the specification](https://github.com/tendermint/spec).
  18. For detailed analysis of the consensus protocol, including safety and liveness proofs,
  19. see our recent paper, "[The latest gossip on BFT consensus](https://arxiv.org/abs/1807.04938)".
  20. ## Releases
  21. Please do not depend on master as your production branch. Use [releases](https://github.com/tendermint/tendermint/releases) instead.
  22. 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.
  23. See below for more details about [versioning](#versioning).
  24. In any case, if you intend to run Tendermint in production, we're happy to help. You can
  25. contact us [over email](mailto:hello@interchain.berlin) or [join the chat](https://discord.gg/cosmosnetwork).
  26. More on how releases are conducted can be found [here](./RELEASES.md).
  27. ## Security
  28. To report a security vulnerability, see our [bug bounty
  29. program](https://hackerone.com/cosmos).
  30. For examples of the kinds of bugs we're looking for, see [our security policy](SECURITY.md).
  31. We also maintain a dedicated mailing list for security updates. We will only ever use this mailing list
  32. to notify you of vulnerabilities and fixes in Tendermint Core. You can subscribe [here](http://eepurl.com/gZ5hQD).
  33. ## Minimum requirements
  34. | Requirement | Notes |
  35. |-------------|------------------|
  36. | Go version | Go1.16 or higher |
  37. ## Documentation
  38. Complete documentation can be found on the [website](https://docs.tendermint.com/master/).
  39. ### Install
  40. See the [install instructions](/docs/introduction/install.md).
  41. ### Quick Start
  42. - [Single node](/docs/introduction/quick-start.md)
  43. - [Local cluster using docker-compose](/docs/networks/docker-compose.md)
  44. - [Remote cluster using Terraform and Ansible](/docs/networks/terraform-and-ansible.md)
  45. - [Join the Cosmos testnet](https://cosmos.network/testnet)
  46. ## Contributing
  47. Please abide by the [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions.
  48. Before contributing to the project, please take a look at the [contributing guidelines](CONTRIBUTING.md)
  49. and the [style guide](STYLE_GUIDE.md). You may also find it helpful to read the
  50. [specifications](https://github.com/tendermint/spec), watch the [Developer Sessions](/docs/DEV_SESSIONS.md),
  51. and familiarize yourself with our
  52. [Architectural Decision Records](https://github.com/tendermint/tendermint/tree/master/docs/architecture).
  53. ## Versioning
  54. ### Semantic Versioning
  55. Tendermint uses [Semantic Versioning](http://semver.org/) to determine when and how the version changes.
  56. According to SemVer, anything in the public API can change at any time before version 1.0.0
  57. To provide some stability to users of 0.X.X versions of Tendermint, the MINOR version is used
  58. to signal breaking changes across Tendermint's API. This API includes all
  59. publicly exposed types, functions, and methods in non-internal Go packages as well as
  60. the types and methods accessible via the Tendermint RPC interface.
  61. Breaking changes to these public APIs will be documented in the CHANGELOG.
  62. ### Upgrades
  63. In an effort to avoid accumulating technical debt prior to 1.0.0,
  64. we do not guarantee that breaking changes (ie. bumps in the MINOR version)
  65. will work with existing Tendermint blockchains. In these cases you will
  66. have to start a new blockchain, or write something custom to get the old
  67. data into the new chain. However, any bump in the PATCH version should be
  68. compatible with existing blockchain histories.
  69. For more information on upgrading, see [UPGRADING.md](./UPGRADING.md).
  70. ### Supported Versions
  71. Because we are a small core team, we only ship patch updates, including security updates,
  72. to the most recent minor release and the second-most recent minor release. Consequently,
  73. we strongly recommend keeping Tendermint up-to-date. Upgrading instructions can be found
  74. in [UPGRADING.md](./UPGRADING.md).
  75. ## Resources
  76. ### Tendermint Core
  77. We keep a public up-to-date version of our roadmap [here](./docs/roadmap/roadmap.md)
  78. For details about the blockchain data structures and the p2p protocols, see the
  79. [Tendermint specification](https://docs.tendermint.com/master/spec/).
  80. For details on using the software, see the [documentation](/docs/) which is also
  81. hosted at: <https://docs.tendermint.com/master/>
  82. ### Tools
  83. Benchmarking is provided by [`tm-load-test`](https://github.com/informalsystems/tm-load-test).
  84. Additional tooling can be found in [/docs/tools](/docs/tools).
  85. ### Applications
  86. - [Cosmos SDK](http://github.com/cosmos/cosmos-sdk); a cryptocurrency application framework
  87. - [Ethermint](http://github.com/cosmos/ethermint); Ethereum on Tendermint
  88. - [Many more](https://tendermint.com/ecosystem)
  89. ### Research
  90. - [The latest gossip on BFT consensus](https://arxiv.org/abs/1807.04938)
  91. - [Master's Thesis on Tendermint](https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769)
  92. - [Original Whitepaper: "Tendermint: Consensus Without Mining"](https://tendermint.com/static/docs/tendermint.pdf)
  93. - [Tendermint Core Blog](https://medium.com/tendermint/tagged/tendermint-core)
  94. - [Cosmos Blog](https://blog.cosmos.network/tendermint/home)
  95. ## Join us!
  96. Tendermint Core is maintained by [Interchain GmbH](https://interchain.berlin).
  97. If you'd like to work full-time on Tendermint Core, [we're hiring](https://interchain-gmbh.breezy.hr/p/682fb7e8a6f601-software-engineer-tendermint-core)!
  98. Funding for Tendermint Core development comes primarily from the [Interchain Foundation](https://interchain.io),
  99. a Swiss non-profit. The Tendermint trademark is owned by [Tendermint Inc.](https://tendermint.com), the for-profit entity
  100. that also maintains [tendermint.com](https://tendermint.com).