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.
 
 
 
 
 
 
William Banfield 2a74c9c498
update readme to more accurately reflect the tendermint public api (#6916)
3 years ago
.github build(deps): Bump docker/setup-buildx-action from 1.5.0 to 1.6.0 (#6903) 3 years ago
DOCKER tooling: use go version 1.16 as minimum version (#6642) 3 years ago
abci tools: add mockery to tools.go and remove mockery version strings (#6787) 3 years ago
cmd rename configuration parameters to use the new blocksync nomenclature (#6896) 3 years ago
config rename configuration parameters to use the new blocksync nomenclature (#6896) 3 years ago
crypto statesync: implement p2p state provider (#6807) 3 years ago
docs rename configuration parameters to use the new blocksync nomenclature (#6896) 3 years ago
inspect inspect: add inspect mode for debugging crashed tendermint node (#6785) 3 years ago
internal upgrading: add information into the UPGRADING.md for users of the codebase wishing to upgrade (#6898) 3 years ago
libs time: make median time library type private (#6853) 3 years ago
light statesync: implement p2p state provider (#6807) 3 years ago
networks networks: update to latest DigitalOcean modules (#6902) 3 years ago
node rename configuration parameters to use the new blocksync nomenclature (#6896) 3 years ago
privval cleanup: remove redundant error plumbing (#6778) 3 years ago
proto/tendermint statesync: implement p2p state provider (#6807) 3 years ago
proxy tools: add mockery to tools.go and remove mockery version strings (#6787) 3 years ago
rpc e2e: clean up generation of evidence (#6904) 3 years ago
scripts tools: add mockery to tools.go and remove mockery version strings (#6787) 3 years ago
state Update the psql indexer schema and implementation (#6868) 3 years ago
store blockstore: fix problem with seen commit (#6782) 3 years ago
test rename configuration parameters to use the new blocksync nomenclature (#6896) 3 years ago
third_party/proto/gogoproto proto: add buf and protogen script (#4369) 5 years ago
tools tools: add mockery to tools.go and remove mockery version strings (#6787) 3 years ago
types e2e: clean up generation of evidence (#6904) 3 years ago
version release: update changelog and version (#6599) 3 years ago
.clang-format ux: use docker to format proto files (#5384) 4 years ago
.dockerignore test: add end-to-end testing framework (#5435) 4 years ago
.editorconfig merge 2 rules in .editorconfig 7 years ago
.gitignore abci: Fix gitignore abci-cli (#6668) 3 years ago
.golangci.yml cleanup: fix order of linters in the golangci-lint config (#6910) 3 years ago
.goreleaser.yml goreleaser: downcase archive and binary names (#6029) 4 years ago
.markdownlintignore crypto: add in secp256k1 support (#5500) 4 years ago
CHANGELOG.md update changelog ahead of v0.35 release (#6893) 3 years ago
CHANGELOG_PENDING.md update changelog ahead of v0.35 release (#6893) 3 years ago
CODE_OF_CONDUCT.md lint: add markdown linter (#5254) 4 years ago
CONTRIBUTING.md contributing: remove release_notes.md reference (#6846) 3 years ago
LICENSE GPLv3 -> Apache2.0 8 years ago
Makefile tools: add mockery to tools.go and remove mockery version strings (#6787) 3 years ago
README.md update readme to more accurately reflect the tendermint public api (#6916) 3 years ago
SECURITY.md Minor update to security.md (#6337) 4 years ago
STYLE_GUIDE.md lint: add markdown linter (#5254) 4 years ago
UPGRADING.md rename configuration parameters to use the new blocksync nomenclature (#6896) 3 years ago
buf.gen.yaml buf: modify buf.yml, add buf generate (#5653) 4 years ago
buf.yaml buf: modify buf.yml, add buf generate (#5653) 4 years ago
docker-compose.yml localnet: use 27000 port for prometheus (#5811) 4 years ago
dredd.yml docs: rename swagger to openapi (#5263) 4 years ago
go.mod rename configuration parameters to use the new blocksync nomenclature (#6896) 3 years ago
go.sum build(deps): Bump github.com/golangci/golangci-lint (#6907) 3 years ago

README.md

Tendermint

banner

Byzantine-Fault Tolerant State Machines. Or Blockchain, for short.

version API Reference Go version Discord chat license tendermint/tendermint Sourcegraph

Branch Tests Coverage Linting
master Tests codecov Lint

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.

For protocol details, see the specification.

For detailed analysis of the consensus protocol, including safety and liveness proofs, see our recent paper, "The latest gossip on BFT consensus".

Releases

Please do not depend on master as your production branch. Use 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.

In any case, if you intend to run Tendermint in production, we're happy to help. You can contact us over email or join the chat.

Security

To report a security vulnerability, see our bug bounty program. For examples of the kinds of bugs we're looking for, see our security policy.

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.

Minimum requirements

Requirement Notes
Go version Go1.16 or higher

Documentation

Complete documentation can be found on the website.

Install

See the install instructions.

Quick Start

Contributing

Please abide by the Code of Conduct in all interactions.

Before contributing to the project, please take a look at the contributing guidelines and the style guide. You may also find it helpful to read the specifications, watch the Developer Sessions, and familiarize yourself with our Architectural Decision Records.

Versioning

Semantic Versioning

Tendermint uses Semantic Versioning 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

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.

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.

Resources

Tendermint Core

For details about the blockchain data structures and the p2p protocols, see the Tendermint specification.

For details on using the software, see the documentation which is also hosted at: https://docs.tendermint.com/master/

Tools

Benchmarking is provided by tm-load-test. Additional tooling can be found in /docs/tools.

Applications

Research

Join us!

Tendermint Core is maintained by Interchain GmbH. If you'd like to work full-time on Tendermint Core, we're hiring!

Funding for Tendermint Core development comes primarily from the Interchain Foundation, a Swiss non-profit. The Tendermint trademark is owned by Tendermint Inc., the for-profit entity that also maintains tendermint.com.