-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* docs: update readme badges * docs: remove some tendermint info that isn't needed * docs: update some tendermint refs and reorg * docs: add missing link * docs: reorganize some info * docs: update link in install doc to point at dashmate page * docs: remove tendermint related resources
- Loading branch information
Showing
2 changed files
with
46 additions
and
112 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,152 +1,86 @@ | ||
| # Tendermint | ||
| # Tenderdash | ||
|
|
||
|  | ||
|
|
||
| [Byzantine-Fault Tolerant](https://en.wikipedia.org/wiki/Byzantine_fault_tolerance) | ||
| [State Machine Replication](https://en.wikipedia.org/wiki/State_machine_replication). | ||
| Or [Blockchain](<https://en.wikipedia.org/wiki/Blockchain_(database)>), for short. | ||
|
|
||
| [](https://github.com/dashevo/tenderdash/releases/latest) | ||
| [](https://pkg.go.dev/github.com/tendermint/tendermint) | ||
| [](https://github.com/moovweb/gvm) | ||
| [](https://discord.gg/AzefAFd) | ||
| [](https://github.com/tendermint/tendermint/blob/master/LICENSE) | ||
| [](https://github.com/tendermint/tendermint) | ||
| [](https://sourcegraph.com/github.com/tendermint/tendermint?badge) | ||
| [](https://github.com/dashpay/tenderdash/releases/latest) | ||
| [](https://github.com/moovweb/gvm) | ||
| [](https://chat.dashdevs.org) | ||
| [](https://github.com/dashpay/tenderdash) | ||
|
|
||
| | Branch | Tests | Coverage | Linting | | ||
| |--------|--------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------| | ||
| | master |  | [](https://codecov.io/gh/tendermint/tendermint) |  | | ||
| | Branch | Tests | Coverage | Linting | | ||
| |--------|-------|----------|---------| | ||
| | master | [](https://github.com/dashpay/tenderdash/actions/workflows/tests.yml) | [](https://codecov.io/gh/dashpay/tenderdash) | [](https://github.com/dashpay/tenderdash/actions/workflows/lint.yml) | | ||
|
|
||
| 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. | ||
| Tenderdash 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. | ||
|
|
||
| For protocol details, refer to the [Tendermint Specification](./spec/README.md). | ||
| ## Background | ||
|
|
||
| For detailed analysis of the consensus protocol, including safety and liveness proofs, | ||
| read our paper, "[The latest gossip on BFT consensus](https://arxiv.org/abs/1807.04938)". | ||
| Tenderdash started as a fork of the [Tendermint Core](https://www.github.com/tendermint/tendermint) | ||
| project and has been used in public environments such as the Cosmos Network. Although based on | ||
| Tendermint, Tenderdash differs from Tendermint through its use of Dash's [long-living masternode | ||
| quorums (LLMQs)](https://github.com/dashpay/dips/blob/master/dip-0006.md) to support threshold | ||
| signatures, quorum-based voting, and dynamic validator set rotation. These enhancements to support | ||
| rapid transaction finality and maintain strong security guarantees make Tenderdash ideal for Dash | ||
| Platform’s needs. | ||
|
|
||
| ## Documentation | ||
|
|
||
| Complete documentation can be found on the [website](https://docs.tendermint.com/). | ||
| For Tendermint protocol details, refer to the [Tendermint Specification](./spec/README.md). For a | ||
| detailed analysis of the consensus protocol, including safety and liveness proofs, read the | ||
| Tendermint paper, "[The latest gossip on BFT consensus](https://arxiv.org/abs/1807.04938)". | ||
| Tendermint documentation can be found on [docs.tendermint.com](https://docs.tendermint.com/). | ||
|
|
||
| ## Releases | ||
|
|
||
| Please do not depend on master as your production branch. Use [releases](https://github.com/tendermint/tendermint/releases) instead. | ||
|
|
||
| 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. | ||
| See below for more details about [versioning](#versioning). | ||
|
|
||
| In any case, if you intend to run Tendermint in production, we're happy to help. You can | ||
| contact us [over email](mailto:[email protected]) or [join the chat](https://discord.gg/cosmosnetwork). | ||
|
|
||
| More on how releases are conducted can be found [here](./RELEASES.md). | ||
| Please do not depend on master as your production branch. Use the binaries provided on the [GitHub | ||
| releases page](https://github.com/dashpay/tenderdash/releases) instead. | ||
|
|
||
| ## Security | ||
| ## Install | ||
|
|
||
| To report a security vulnerability, see our [bug bounty | ||
| program](https://hackerone.com/cosmos). | ||
| For examples of the kinds of bugs we're looking for, see [our security policy](SECURITY.md). | ||
| See the [install instructions](./docs/introduction/install.md). Make sure to meet the minimum | ||
| requirements if installing from source. | ||
|
|
||
| We also maintain a dedicated mailing list for security updates. We will only ever use this mailing list | ||
| to notify you of vulnerabilities and fixes in Tendermint Core. You can subscribe [here](http://eepurl.com/gZ5hQD). | ||
|
|
||
| We also maintain a dedicated mailing list for security updates. We will only ever use this mailing list | ||
| to notify you of vulnerabilities and fixes in Tendermint Core. You can subscribe [here](http://eepurl.com/gZ5hQD). | ||
|
|
||
| ## Minimum requirements | ||
| ### Minimum requirements | ||
|
|
||
| | Requirement | Notes | | ||
| |-------------|------------------| | ||
| | Go version | Go1.22 or higher | | ||
|
|
||
| ### Install | ||
|
|
||
| See the [install instructions](./docs/introduction/install.md). | ||
|
|
||
| ### Quick Start | ||
|
|
||
| - [Single node](./docs/introduction/quick-start.md) | ||
| - [Local cluster using docker-compose](./docs/tools/docker-compose.md) | ||
| - [Remote cluster using Terraform and Ansible](./docs/tools/terraform-and-ansible.md) | ||
|
|
||
| ## Contributing | ||
|
|
||
| Please abide by the [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions. | ||
|
|
||
| Before contributing to the project, please take a look at the [contributing guidelines](CONTRIBUTING.md) | ||
| and the [style guide](STYLE_GUIDE.md). You may also find it helpful to read the | ||
| [specifications](./spec/README.md), | ||
| and familiarize yourself with our | ||
| [Architectural Decision Records (ADRs)](./docs/architecture/README.md) and [Request For Comments (RFCs)](./docs/rfc/README.md). | ||
|
|
||
| ## Versioning | ||
|
|
||
| ### Semantic Versioning | ||
|
|
||
| Tendermint uses [Semantic Versioning](http://semver.org/) to determine when and how the version changes. | ||
| According to SemVer, anything in the public API can change at any time before version 1.0.0 | ||
| Tenderdash uses [Semantic Versioning](http://semver.org/) to determine when and how the version | ||
| changes. | ||
|
|
||
| To provide some stability to users of 0.X.X versions of Tendermint, the MINOR version is used | ||
| to signal breaking changes across Tendermint's API. This API includes all | ||
| publicly exposed types, functions, and methods in non-internal Go packages as well as | ||
| the types and methods accessible via the Tendermint RPC interface. | ||
|
|
||
| Breaking changes to these public APIs will be documented in the CHANGELOG. | ||
|
|
||
| ### 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 blockchain histories. | ||
|
|
||
| For more information on upgrading, see [UPGRADING.md](./UPGRADING.md). | ||
| The Tenderdash API includes all publicly exposed types, functions, and methods in non-internal Go | ||
| packages as well as the types and methods accessible via the RPC interface. Breaking changes to | ||
| these public APIs will be documented in the [CHANGELOG](./CHANGELOG.md). | ||
|
|
||
| ### Supported Versions | ||
|
|
||
| Because we are a small core team, we only ship patch updates, including security updates, | ||
| to the most recent minor release and the second-most recent minor release. Consequently, | ||
| we strongly recommend keeping Tendermint up-to-date. Upgrading instructions can be found | ||
| in [UPGRADING.md](./UPGRADING.md). | ||
| Because we are a small core team, we only ship patch updates, including security updates, to the | ||
| most recent minor release and the second-most recent minor release. Consequently, we strongly | ||
| recommend keeping Tenderdash up-to-date. | ||
|
|
||
| ## Resources | ||
|
|
||
| ### Roadmap | ||
|
|
||
| We keep a public up-to-date version of our roadmap [here](./docs/roadmap/roadmap.md) | ||
|
|
||
| ### Libraries | ||
|
|
||
| - [Cosmos SDK](http://github.com/cosmos/cosmos-sdk); A framework for building applications in Golang | ||
| - [Tendermint in Rust](https://github.com/informalsystems/tendermint-rs) | ||
| - [ABCI Tower](https://github.com/penumbra-zone/tower-abci) | ||
|
|
||
| ### Applications | ||
|
|
||
| - [Cosmos Hub](https://hub.cosmos.network/) | ||
| - [Terra](https://www.terra.money/) | ||
| - [Celestia](https://celestia.org/) | ||
| - [Anoma](https://anoma.network/) | ||
| - [Vocdoni](https://docs.vocdoni.io/) | ||
|
|
||
| ### Research | ||
|
|
||
| - [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: "Tendermint: Consensus Without Mining"](https://tendermint.com/static/docs/tendermint.pdf) | ||
| - [Tendermint Core Blog](https://medium.com/tendermint/tagged/tendermint-core) | ||
| - [Cosmos Blog](https://blog.cosmos.network/tendermint/home) | ||
|
|
||
| ## Join us | ||
| ## Contributing | ||
|
|
||
| Tenderdash is maintained by [Dash Core Group](https://www.dash.org/dcg/). | ||
| If you'd like to work full-time on Tenderdash, [see our Jobs page](https://www.dash.org/dcg/jobs/). | ||
| Before contributing to the project, please take a look at the [contributing | ||
| guidelines](CONTRIBUTING.md) and the [style guide](STYLE_GUIDE.md). You may also find it helpful to | ||
| read the [Tendermint specifications](./spec/README.md), and familiarize yourself with the | ||
| [Architectural Decision Records (ADRs)](./docs/architecture/README.md) and [Request For Comments | ||
| (RFCs)](./docs/rfc/README.md). | ||
|
|
||
| Tendermint Core is maintained by [Interchain GmbH](https://interchain.berlin). | ||
| If you'd like to work full-time on Tendermint Core, [we're hiring](https://interchain-gmbh.breezy.hr/)! | ||
| ## Join us | ||
|
|
||
| Funding for Tendermint Core development comes primarily from the [Interchain Foundation](https://interchain.io), | ||
| a Swiss non-profit. The Tendermint trademark is owned by [Tendermint Inc.](https://tendermint.com), the for-profit entity | ||
| that also maintains [tendermint.com](https://tendermint.com). | ||
| Tenderdash is maintained by [Dash Core Group](https://www.dash.org/dcg/). If you'd like to work | ||
| full-time on Tenderdash, [see our Jobs page](https://www.dash.org/dcg/jobs/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters