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.
 
 
 
 
 
 
Marko ceb105316b
Docs theme latest (#4179)
5 years ago
.circleci added staging build step to docs deployment (#4129) 5 years ago
.github stale bot (#4049) 5 years ago
DOCKER doc: fix broken links (#4186) 5 years ago
abci Fixed typo (#4181) 5 years ago
behaviour linters: enable stylecheck (#4153) 5 years ago
blockchain linters: enable stylecheck (#4153) 5 years ago
cmd linters: enable stylecheck (#4153) 5 years ago
config Fix linter errors thrown by `lll` (#3970) 5 years ago
consensus cs: clarify where 24 comes from in maxMsgSizeBytes (wal.go) 5 years ago
crypto prefix proto types (#4007) 5 years ago
docs Docs theme latest (#4179) 5 years ago
evidence linters: enable stylecheck (#4153) 5 years ago
libs prefix proto types (#4007) 5 years ago
lite Remvoe errors package from libs (#4157) 5 years ago
mempool linters: enable stylecheck (#4153) 5 years ago
mock mempool: moved TxInfo parameter into Mempool.CheckTx() (#4083) 5 years ago
networks doc: fix broken links (#4186) 5 years ago
node update tm-db to 0.3.0 (#4158) 5 years ago
p2p linters: enable stylecheck (#4153) 5 years ago
privval linters: enable stylecheck (#4153) 5 years ago
proxy linters: enable stylecheck (#4153) 5 years ago
rpc doc: fix broken links (#4186) 5 years ago
scripts linters: enable stylecheck (#4153) 5 years ago
state update tm-db to 0.3.0 (#4158) 5 years ago
store abci: remove TotalTxs and NumTxs from Header (#3783) 5 years ago
test Update Makefile (#3949) 5 years ago
tools doc: fix broken links (#4186) 5 years ago
types types: remove dots from errors in SignedHeader#ValidateBasic 5 years ago
version CHANGELOG: update release/v0.32.8 details (#4162) 5 years ago
.editorconfig merge 2 rules in .editorconfig 7 years ago
.gitignore Latest version of the theme (#4108) 5 years ago
.golangci.yml linters: enable stylecheck (#4153) 5 years ago
CHANGELOG.md doc: fix broken links (#4186) 5 years ago
CHANGELOG_PENDING.md changelog: GotVoteFromUnwantedRoundError -> ErrGotVoteFromUnwantedRound 5 years ago
CODE_OF_CONDUCT.md update some top-level markdown files (#2841) 6 years ago
CONTRIBUTING.md Docs theme (#4042) 5 years ago
LICENSE GPLv3 -> Apache2.0 9 years ago
Makefile tools.mk: install protoc 5 years ago
PHILOSOPHY.md add design philosophy doc (#3034) 6 years ago
README.md doc: fix broken links (#4186) 5 years ago
SECURITY.md update some top-level markdown files (#2841) 6 years ago
UPGRADING.md docs: remove traces of develop branch (#4022) 5 years ago
Vagrantfile Vagrantfile: update Go version 5 years ago
appveyor.yml switch to go mod (#3613) 6 years ago
codecov.yml Remove pb.go files from codecov 7 years ago
docker-compose.yml localnet: fix $LOG variable (#3423) 6 years ago
dredd.yml Docs theme (#4042) 5 years ago
go.mod update tm-db to 0.3.0 (#4158) 5 years ago
go.sum update tm-db to 0.3.0 (#4158) 5 years ago
tests.mk Update Makefile (#3949) 5 years ago
tools.mk tools.mk: install protoc 5 years ago

README.md

Tendermint

banner

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

version API Reference Go version riot.im license

Branch Tests Coverage
master CircleCI codecov

Tendermint Core is 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

NOTE: The master branch is now an active development branch (starting with v0.32). Please, do not depend on it and use releases instead.

Tendermint is being used in production in both private and public environments, most notably the blockchains of the Cosmos Network. However, we are still making breaking changes to the protocol and the APIs and have not yet released v1.0. See below for more details about versioning.

In any case, if you intend to run Tendermint in production, please contact us and 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 SECURITY.md

Minimum requirements

Requirement Notes
Go version Go1.11.4 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, and the contributing guidelines when submitting code.

Join the larger community on the forum and the chat.

To learn more about the structure of the software, watch the Developer Sessions and read some Architectural Decision Records.

Learn more by reading the code and comparing it to the specification.

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 Tendermint users in these 0.X.X days, the MINOR version is used to signal breaking changes across a subset of the total public API. This subset includes all interfaces exposed to other processes (cli, rpc, p2p, etc.), but does not include the in-process Go APIs.

That said, breaking changes in the following packages will be documented in the CHANGELOG even if they don't lead to MINOR version bumps:

  • crypto
  • types
  • rpc/client
  • config
  • node
  • libs
    • bech32
    • common
    • db
    • errors
    • log

Exported objects in these packages that are not covered by the versioning scheme are explicitly marked by // UNSTABLE in their go doc comment and may change at any time without notice. Functions, types, and values in any other package may also change at any time.

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 histories (if not please open an issue).

For more information on upgrading, see 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 and monitoring is provided by tm-load-test and tm-monitor, respectively. The code for tm-monitor can be found here and the code for tm-load-test can be found here these binaries need to be built seperately. Additional documentation is found here.

Sub-projects

  • Amino, reflection-based proto3, with interfaces
  • IAVL, Merkleized IAVL+ Tree implementation
  • Tm-cmn, Commonly used libs across Tendermint & Cosmos repos

Applications

Research