github.com/DFWallet/tendermint-cosmos@v0.0.2/README.md (about) 1 # Tendermint 2 3  4 5 [Byzantine-Fault Tolerant](https://en.wikipedia.org/wiki/Byzantine_fault_tolerance) 6 [State Machines](https://en.wikipedia.org/wiki/State_machine_replication). 7 Or [Blockchain](<https://en.wikipedia.org/wiki/Blockchain_(database)>), for short. 8 9 [](https://github.com/DFWallet/tendermint-cosmos/releases/latest) 10 [](https://pkg.go.dev/github.com/DFWallet/tendermint-cosmos) 11 [](https://github.com/moovweb/gvm) 12 [](https://discord.gg/AzefAFd) 13 [](https://github.com/DFWallet/tendermint-cosmos/blob/master/LICENSE) 14 [](https://github.com/DFWallet/tendermint-cosmos) 15 [](https://sourcegraph.com/github.com/DFWallet/tendermint-cosmos?badge) 16 17 | Branch | Tests | Coverage | Linting | 18 | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | 19 | master | [](https://circleci.com/gh/tendermint/tendermint/tree/master) </br>  | [](https://codecov.io/gh/tendermint/tendermint) |  | 20 21 Tendermint Core is Byzantine Fault Tolerant (BFT) middleware that takes a state transition machine - written in any programming language - 22 and securely replicates it on many machines. 23 24 For protocol details, see [the specification](https://github.com/tendermint/spec). 25 26 For detailed analysis of the consensus protocol, including safety and liveness proofs, 27 see our recent paper, "[The latest gossip on BFT consensus](https://arxiv.org/abs/1807.04938)". 28 29 ## Releases 30 31 Please do not depend on master as your production branch. Use [releases](https://github.com/DFWallet/tendermint-cosmos/releases) instead. 32 33 Tendermint is being used in production in both private and public environments, 34 most notably the blockchains of the [Cosmos Network](https://cosmos.network/). 35 However, we are still making breaking changes to the protocol and the APIs and have not yet released v1.0. 36 See below for more details about [versioning](#versioning). 37 38 In any case, if you intend to run Tendermint in production, we're happy to help. You can 39 contact us [over email](mailto:hello@interchain.berlin) or [join the chat](https://discord.gg/AzefAFd). 40 41 ## Security 42 43 To report a security vulnerability, see our [bug bounty 44 program](https://hackerone.com/tendermint). 45 For examples of the kinds of bugs we're looking for, see [our security policy](SECURITY.md) 46 47 We also maintain a dedicated mailing list for security updates. We will only ever use this mailing list 48 to notify you of vulnerabilities and fixes in Tendermint Core. You can subscribe [here](http://eepurl.com/gZ5hQD). 49 50 ## Minimum requirements 51 52 | Requirement | Notes | 53 | ----------- | ---------------- | 54 | Go version | Go1.15 or higher | 55 56 ## Documentation 57 58 Complete documentation can be found on the [website](https://docs.tendermint.com/master/). 59 60 ### Install 61 62 See the [install instructions](/docs/introduction/install.md). 63 64 ### Quick Start 65 66 - [Single node](/docs/introduction/quick-start.md) 67 - [Local cluster using docker-compose](/docs/networks/docker-compose.md) 68 - [Remote cluster using Terraform and Ansible](/docs/networks/terraform-and-ansible.md) 69 - [Join the Cosmos testnet](https://cosmos.network/testnet) 70 71 ## Contributing 72 73 Please abide by the [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions. 74 75 Before contributing to the project, please take a look at the [contributing guidelines](CONTRIBUTING.md) 76 and the [style guide](STYLE_GUIDE.md). You may also find it helpful to read the 77 [specifications](https://github.com/tendermint/spec), watch the [Developer Sessions](/docs/DEV_SESSIONS.md), 78 and familiarize yourself with our 79 [Architectural Decision Records](https://github.com/DFWallet/tendermint-cosmos/tree/master/docs/architecture). 80 81 ## Versioning 82 83 ### Semantic Versioning 84 85 Tendermint uses [Semantic Versioning](http://semver.org/) to determine when and how the version changes. 86 According to SemVer, anything in the public API can change at any time before version 1.0.0 87 88 To provide some stability to Tendermint users in these 0.X.X days, the MINOR version is used 89 to signal breaking changes across a subset of the total public API. This subset includes all 90 interfaces exposed to other processes (cli, rpc, p2p, etc.), but does not 91 include the Go APIs. 92 93 That said, breaking changes in the following packages will be documented in the 94 CHANGELOG even if they don't lead to MINOR version bumps: 95 96 - crypto 97 - config 98 - libs 99 - bech32 100 - bits 101 - bytes 102 - json 103 - log 104 - math 105 - net 106 - os 107 - protoio 108 - rand 109 - sync 110 - strings 111 - service 112 - node 113 - rpc/client 114 - types 115 116 ### Upgrades 117 118 In an effort to avoid accumulating technical debt prior to 1.0.0, 119 we do not guarantee that breaking changes (ie. bumps in the MINOR version) 120 will work with existing Tendermint blockchains. In these cases you will 121 have to start a new blockchain, or write something custom to get the old 122 data into the new chain. However, any bump in the PATCH version should be 123 compatible with existing blockchain histories. 124 125 126 For more information on upgrading, see [UPGRADING.md](./UPGRADING.md). 127 128 ### Supported Versions 129 130 Because we are a small core team, we only ship patch updates, including security updates, 131 to the most recent minor release and the second-most recent minor release. Consequently, 132 we strongly recommend keeping Tendermint up-to-date. Upgrading instructions can be found 133 in [UPGRADING.md](./UPGRADING.md). 134 135 ## Resources 136 137 ### Tendermint Core 138 139 For details about the blockchain data structures and the p2p protocols, see the 140 [Tendermint specification](https://docs.tendermint.com/master/spec/). 141 142 For details on using the software, see the [documentation](/docs/) which is also 143 hosted at: <https://docs.tendermint.com/master/> 144 145 ### Tools 146 147 Benchmarking is provided by [`tm-load-test`](https://github.com/informalsystems/tm-load-test). 148 Additional tooling can be found in [/docs/tools](/docs/tools). 149 150 ### Applications 151 152 - [Cosmos SDK](http://github.com/cosmos/cosmos-sdk); a cryptocurrency application framework 153 - [Ethermint](http://github.com/cosmos/ethermint); Ethereum on Tendermint 154 - [Many more](https://tendermint.com/ecosystem) 155 156 ### Research 157 158 - [The latest gossip on BFT consensus](https://arxiv.org/abs/1807.04938) 159 - [Master's Thesis on Tendermint](https://atrium.lib.uoguelph.ca/xmlui/handle/10214/9769) 160 - [Original Whitepaper: "Tendermint: Consensus Without Mining"](https://tendermint.com/static/docs/tendermint.pdf) 161 - [Blog](https://blog.cosmos.network/tendermint/home)