github.com/Team-Kujira/tendermint@v0.34.24-indexer/README.md (about) 1 # Tendermint 2 3 ![banner](docs/tendermint-core-image.jpg) 4 5 [Byzantine-Fault Tolerant][bft] [State Machine Replication][smr]. Or 6 [Blockchain], for short. 7 8 [![Version][version-badge]][version-url] 9 [![API Reference][api-badge]][api-url] 10 [![Go version][go-badge]][go-url] 11 [![Discord chat][discord-badge]][discord-url] 12 [![License][license-badge]][license-url] 13 [![Sourcegraph][sg-badge]][sg-url] 14 15 | Branch | Tests | Linting | 16 |--------|------------------------------------|---------------------------------| 17 | main | [![Tests][tests-badge]][tests-url] | [![Lint][lint-badge]][lint-url] | 18 19 Tendermint Core is a Byzantine Fault Tolerant (BFT) middleware that takes a 20 state transition machine - written in any programming language - and securely 21 replicates it on many machines. 22 23 For protocol details, refer to the [Tendermint Specification](./spec/README.md). 24 25 For detailed analysis of the consensus protocol, including safety and liveness 26 proofs, read our paper, "[The latest gossip on BFT 27 consensus](https://arxiv.org/abs/1807.04938)". 28 29 ## Documentation 30 31 Complete documentation can be found on the 32 [website](https://docs.tendermint.com/). 33 34 ## Releases 35 36 Please do not depend on `main` as your production branch. Use 37 [releases](https://github.com/tendermint/tendermint/releases) instead. 38 39 Tendermint has been in the production of private and public environments, most 40 notably the blockchains of the Cosmos Network. we haven't released v1.0 yet 41 since we are making breaking changes to the protocol and the APIs. See below for 42 more details about [versioning](#versioning). 43 44 In any case, if you intend to run Tendermint in production, we're happy to help. 45 You can contact us [over email](mailto:hello@interchain.io) or [join the 46 chat](https://discord.gg/cosmosnetwork). 47 48 More on how releases are conducted can be found [here](./RELEASES.md). 49 50 ## Security 51 52 To report a security vulnerability, see our [bug bounty 53 program](https://hackerone.com/cosmos). For examples of the kinds of bugs we're 54 looking for, see [our security policy](SECURITY.md). 55 56 We also maintain a dedicated mailing list for security updates. We will only 57 ever use this mailing list to notify you of vulnerabilities and fixes in 58 Tendermint Core. You can subscribe [here](http://eepurl.com/gZ5hQD). 59 60 ## Minimum requirements 61 62 | Requirement | Notes | 63 |-------------|-------------------| 64 | Go version | Go 1.18 or higher | 65 66 ### Install 67 68 See the [install instructions](./docs/introduction/install.md). 69 70 ### Quick Start 71 72 - [Single node](./docs/introduction/quick-start.md) 73 - [Local cluster using docker-compose](./docs/tools/docker-compose.md) 74 - [Remote cluster using Terraform and Ansible](./docs/tools/terraform-and-ansible.md) 75 76 ## Contributing 77 78 Please abide by the [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions. 79 80 Before contributing to the project, please take a look at the [contributing 81 guidelines](CONTRIBUTING.md) and the [style guide](STYLE_GUIDE.md). You may also 82 find it helpful to read the [specifications](./spec/README.md), and familiarize 83 yourself with our [Architectural Decision Records 84 (ADRs)](./docs/architecture/README.md) and 85 [Request For Comments (RFCs)](./docs/rfc/README.md). 86 87 ## Versioning 88 89 ### Semantic Versioning 90 91 Tendermint uses [Semantic Versioning](http://semver.org/) to determine when and 92 how the version changes. According to SemVer, anything in the public API can 93 change at any time before version 1.0.0 94 95 To provide some stability to users of 0.X.X versions of Tendermint, the MINOR 96 version is used to signal breaking changes across Tendermint's API. This API 97 includes all publicly exposed types, functions, and methods in non-internal Go 98 packages as well as the types and methods accessible via the Tendermint RPC 99 interface. 100 101 Breaking changes to these public APIs will be documented in the CHANGELOG. 102 103 ### Upgrades 104 105 In an effort to avoid accumulating technical debt prior to 1.0.0, we do not 106 guarantee that breaking changes (ie. bumps in the MINOR version) will work with 107 existing Tendermint blockchains. In these cases you will have to start a new 108 blockchain, or write something custom to get the old data into the new chain. 109 However, any bump in the PATCH version should be compatible with existing 110 blockchain histories. 111 112 For more information on upgrading, see [UPGRADING.md](./UPGRADING.md). 113 114 ### Supported Versions 115 116 Because we are a small core team, we only ship patch updates, including security 117 updates, to the most recent minor release and the second-most recent minor 118 release. Consequently, we strongly recommend keeping Tendermint up-to-date. 119 Upgrading instructions can be found in [UPGRADING.md](./UPGRADING.md). 120 121 ## Resources 122 123 ### Libraries 124 125 - [Cosmos SDK](http://github.com/cosmos/cosmos-sdk); A framework for building 126 applications in Golang 127 - [Tendermint in Rust](https://github.com/informalsystems/tendermint-rs) 128 - [ABCI Tower](https://github.com/penumbra-zone/tower-abci) 129 130 ### Applications 131 132 - [Cosmos Hub](https://hub.cosmos.network/) 133 - [Terra](https://www.terra.money/) 134 - [Celestia](https://celestia.org/) 135 - [Anoma](https://anoma.network/) 136 - [Vocdoni](https://docs.vocdoni.io/) 137 138 ### Research 139 140 - [The latest gossip on BFT consensus](https://arxiv.org/abs/1807.04938) 141 - [Master's Thesis on Tendermint](https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769) 142 - [Original Whitepaper: "Tendermint: Consensus Without Mining"](https://tendermint.com/static/docs/tendermint.pdf) 143 - [Tendermint Core Blog](https://medium.com/tendermint/tagged/tendermint-core) 144 - [Cosmos Blog](https://blog.cosmos.network/tendermint/home) 145 146 ## Join us! 147 148 Tendermint Core is maintained by [Interchain GmbH](https://interchain.berlin). 149 If you'd like to work full-time on Tendermint Core, 150 [we're hiring](https://interchain-gmbh.breezy.hr/)! 151 152 Funding for Tendermint Core development comes primarily from the 153 [Interchain Foundation](https://interchain.io), a Swiss non-profit. The 154 Tendermint trademark is owned by [Tendermint Inc.](https://tendermint.com), the 155 for-profit entity that also maintains [tendermint.com](https://tendermint.com). 156 157 [bft]: https://en.wikipedia.org/wiki/Byzantine_fault_tolerance 158 [smr]: https://en.wikipedia.org/wiki/State_machine_replication 159 [Blockchain]: https://en.wikipedia.org/wiki/Blockchain 160 [version-badge]: https://img.shields.io/github/tag/tendermint/tendermint.svg 161 [version-url]: https://github.com/tendermint/tendermint/releases/latest 162 [api-badge]: https://camo.githubusercontent.com/915b7be44ada53c290eb157634330494ebe3e30a/68747470733a2f2f676f646f632e6f72672f6769746875622e636f6d2f676f6c616e672f6764646f3f7374617475732e737667 163 [api-url]: https://pkg.go.dev/github.com/tendermint/tendermint 164 [go-badge]: https://img.shields.io/badge/go-1.18-blue.svg 165 [go-url]: https://github.com/moovweb/gvm 166 [discord-badge]: https://img.shields.io/discord/669268347736686612.svg 167 [discord-url]: https://discord.gg/cosmosnetwork 168 [license-badge]: https://img.shields.io/github/license/tendermint/tendermint.svg 169 [license-url]: https://github.com/tendermint/tendermint/blob/main/LICENSE 170 [sg-badge]: https://sourcegraph.com/github.com/tendermint/tendermint/-/badge.svg 171 [sg-url]: https://sourcegraph.com/github.com/tendermint/tendermint?badge 172 [tests-url]: https://github.com/tendermint/tendermint/actions/workflows/tests.yml 173 [tests-badge]: https://github.com/tendermint/tendermint/actions/workflows/tests.yml/badge.svg?branch=main 174 [lint-badge]: https://github.com/tendermint/tendermint/actions/workflows/lint.yml/badge.svg 175 [lint-url]: https://github.com/tendermint/tendermint/actions/workflows/lint.yml