github.com/vipernet-xyz/tm@v0.34.24/README.md (about)

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