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.
 
 
 
 
 
 
Tess Rinearson 9fd089f823
README: clean up README (#5391)
4 years ago
.circleci docs: updates to various sections (#5285) 4 years ago
.github ci: fix net run (#5343) 4 years ago
.vscode ux: use docker to format proto files (#5384) 4 years ago
DOCKER docker: fix incorrect time_iota_ms configuration (#5385) 4 years ago
abci lint: enable errcheck (#5336) 4 years ago
behaviour lint: add errchecks (#5316) 4 years ago
blockchain evidence: introduction of LightClientAttackEvidence and refactor of evidence lifecycle (#5361) 4 years ago
cmd rpc/client: take context as first param (#5347) 4 years ago
config mempool: batch txs per peer in broadcastTxRoutine (#5321) 4 years ago
consensus blockstore: fix race conditions when loading data (#5382) 4 years ago
crypto crypto: reword readme (#5349) 4 years ago
docs mempool: batch txs per peer in broadcastTxRoutine (#5321) 4 years ago
evidence evidence: introduction of LightClientAttackEvidence and refactor of evidence lifecycle (#5361) 4 years ago
libs lint: enable errcheck (#5336) 4 years ago
light config: set time_iota_ms to timeout_commit in test genesis (#5386) 4 years ago
mempool mempool: batch txs per peer in broadcastTxRoutine (#5321) 4 years ago
networks add build into make build-docker (#5253) 4 years ago
node rpc/client: take context as first param (#5347) 4 years ago
p2p evidence: introduction of LightClientAttackEvidence and refactor of evidence lifecycle (#5361) 4 years ago
privval lint: add errchecks (#5316) 4 years ago
proto/tendermint mempool: batch txs per peer in broadcastTxRoutine (#5321) 4 years ago
proxy evidence: introduction of LightClientAttackEvidence and refactor of evidence lifecycle (#5361) 4 years ago
rpc blockstore: fix race conditions when loading data (#5382) 4 years ago
scripts lint: add markdown linter (#5254) 4 years ago
state config: set time_iota_ms to timeout_commit in test genesis (#5386) 4 years ago
statesync rpc/client: take context as first param (#5347) 4 years ago
store blockstore: fix race conditions when loading data (#5382) 4 years ago
test consensus: double-sign risk reduction (ADR-51) (#5147) 4 years ago
third_party/proto/gogoproto proto: add buf and protogen script (#4369) 5 years ago
tools lint: enable errcheck (#5336) 4 years ago
types evidence: introduction of LightClientAttackEvidence and refactor of evidence lifecycle (#5361) 4 years ago
version version: bump version numbers (#5173) 4 years ago
.clang-format ux: use docker to format proto files (#5384) 4 years ago
.editorconfig merge 2 rules in .editorconfig 7 years ago
.gitignore proto: folder structure adhere to buf (#5025) 4 years ago
.golangci.yml lint: enable errcheck (#5336) 4 years ago
.markdownlint.yml lint: add markdown linter (#5254) 4 years ago
.markdownlintignore markdownlint: ignore .github directory (#5351) 4 years ago
.mergify.yml mergify: use PR title and body for squash merge commit (#4669) 5 years ago
CHANGELOG.md changelog: add v0.33.8 from release (#5242) 4 years ago
CHANGELOG_PENDING.md changelog: minor tweaks (#5389) 4 years ago
CODE_OF_CONDUCT.md lint: add markdown linter (#5254) 4 years ago
CONTRIBUTING.md docs: rename swagger to openapi (#5263) 4 years ago
LICENSE GPLv3 -> Apache2.0 8 years ago
Makefile ux: use docker to format proto files (#5384) 4 years ago
PHILOSOPHY.md lint: add markdown linter (#5254) 4 years ago
README.md README: clean up README (#5391) 4 years ago
SECURITY.md lint: add markdown linter (#5254) 4 years ago
STYLE_GUIDE.md lint: add markdown linter (#5254) 4 years ago
UPGRADING.md upgrading: state store change (#5364) 4 years ago
Vagrantfile state: revert event hashing (#5159) 4 years ago
appveyor.yml switch to go mod (#3613) 5 years ago
buf.yaml proto: increase lint level to basic and fix lint warnings (#5096) 4 years ago
codecov.yml ci: delay codecov notification (#5275) 4 years ago
docker-compose.yml localnet: fix $LOG variable (#3423) 6 years ago
dredd.yml docs: rename swagger to openapi (#5263) 4 years ago
go.mod build(deps): Bump github.com/minio/highwayhash from 1.0.0 to 1.0.1 (#5370) 4 years ago
go.sum mempool: batch txs per peer in broadcastTxRoutine (#5321) 4 years ago
tests.mk libs: wrap mutexes for build flag with godeadlock (#5126) 4 years ago
tools.mk tools: update gogoproto get cmd (#5007) 4 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 CircleCI
Tests
codecov Lint

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

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

Minimum requirements

Requirement Notes
Go version Go1.14 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 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 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
  • config
  • libs
    • bech32
    • bits
    • bytes
    • json
    • log
    • math
    • net
    • os
    • protoio
    • rand
    • sync
    • strings
    • service
  • node
  • rpc/client
  • types

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