⟁ Tendermint Core (BFT Consensus) in Go
Switch branches/tags
Clone or download
Latest commit 0c9c329 Sep 23, 2018
Permalink
Failed to load latest commit information.
.circleci test make localnet in CI (#2281) Sep 5, 2018
.github remove JB from codeowners file (#2174) Aug 8, 2018
DOCKER Revert "detele everything" Jul 10, 2018
abci conesnsu: follow up to removing some consensus params (#2427) Sep 21, 2018
benchmarks rpc: Transform /status result.node_info.other into map (#2417) Sep 17, 2018
blockchain p2p: Integrate new Transport Sep 18, 2018
cmd Add stats related channel between consensus state and reactor (#2388) Sep 21, 2018
config switch from jmhodges/levigo to DataDog/leveldb Sep 18, 2018
consensus Add stats related channel between consensus state and reactor (#2388) Sep 21, 2018
crypto crypto/secp256k1: Fix signature malleability, adopt more efficient en… ( Aug 28, 2018
docs copy without sudo (#2474) Sep 23, 2018
evidence conesnsu: follow up to removing some consensus params (#2427) Sep 21, 2018
libs docs: Add missing changelog entry and comment (#2451) Sep 20, 2018
lite Implement BFT time (#2203) Aug 31, 2018
mempool Update abci and app docs (#2470) Sep 23, 2018
networks Revert "detele everything" Jul 10, 2018
node mempool: Filter new txs if they have insufficient gas (#2385) Sep 22, 2018
p2p p2p: add RPCAddress to NodeInfoOther.String() (#2442) Sep 19, 2018
privval Implement BFT time (#2203) Aug 31, 2018
proxy proxy: remove Handshaker from proxy pkg (#2437) Sep 19, 2018
rpc Pass http.ServeTLS() errors back to the caller (#2461) Sep 21, 2018
scripts add script to add links in changelog Sep 5, 2018
state mempool: Filter new txs if they have insufficient gas (#2385) Sep 22, 2018
test Remove gogoproto from Makefile's TOOLS (#2198) Aug 10, 2018
tools tools/tm-bench: bounds check for txSize and improving test cases (#2410) Sep 17, 2018
types conesnsu: follow up to removing some consensus params (#2427) Sep 21, 2018
version flush changelog pending, bump version Sep 21, 2018
.editorconfig Revert "delete some things for the merge" Jul 2, 2018
.gitignore docs: Add assets/instructions for local docs build (#2453) Sep 21, 2018
CHANGELOG.md update changelog Sep 23, 2018
CHANGELOG_PENDING.md flush changelog pending, bump version Sep 21, 2018
CODE_OF_CONDUCT.md Revert "detele everything" Jul 10, 2018
CONTRIBUTING.md Revert "detele everything" Jul 10, 2018
Gopkg.lock switch back to original fork Sep 18, 2018
Gopkg.toml switch back to original fork Sep 18, 2018
LICENSE Revert "detele everything" Jul 10, 2018
Makefile Update abci and app docs (#2470) Sep 23, 2018
README.md Minor changelog fixes (#2449) Sep 20, 2018
ROADMAP.md Revert "detele everything" Jul 10, 2018
SECURITY.md Revert "detele everything" Jul 10, 2018
UPGRADING.md update changelog and upgrading Sep 21, 2018
Vagrantfile update Vagrantfile to install go1.11 Sep 18, 2018
appveyor.yml Revert "detele everything" Jul 10, 2018
codecov.yml Remove pb.go files from codecov Jul 17, 2018
docker-compose.yml Revert "detele everything" Jul 10, 2018

README.md

Tendermint

Byzantine-Fault Tolerant State Machine Replication. Or Blockchain for short.

version API Reference Go version riot.im license

Branch Tests Coverage
master CircleCI codecov
develop 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".

A Note on Production Readiness

While Tendermint is being used in production in private, permissioned environments, we are still working actively to harden and audit it in preparation for use in public blockchains, such as the Cosmos Network. We are also still making breaking changes to the protocol and the APIs. Thus, we tag the releases as alpha software.

In any case, if you intend to run Tendermint in production, please contact us :)

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.10 or higher

Install

See the install instructions

Quick Start

Resources

Tendermint Core

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

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

Tools

Benchmarking and monitoring is provided by tm-bench and tm-monitor, respectively. Their code is found here and these binaries need to be built seperately. Additional documentation is found here.

Sub-projects

  • Amino, a reflection-based improvement on proto3
  • IAVL, Merkleized IAVL+ Tree implementation

Applications

Research

Contributing

Yay open source! Please see our contributing guidelines.

Versioning

SemVer

Tendermint uses SemVer 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:

  • types
  • rpc/client
  • config
  • node
  • libs/bech32
  • libs/common
  • libs/db
  • libs/errors
  • libs/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 here

Code of Conduct

Please read, understand and adhere to our code of conduct.