Go to file
ValarDragon f3d519c966 crypto: Fix package imports from the refactor 2018-07-23 16:14:21 -07:00
.circleci Merge remote-tracking branch 'origin/develop' into dev/refactor_crypto 2018-07-18 08:54:51 -07:00
.github add @zramsay & @jolesbi as docs owners 2018-07-04 12:31:17 -04:00
DOCKER move abci Dockerfile (still needs to be updated tho) 2018-07-04 14:19:33 -04:00
abci Add gogo generated tests for pb.go files 2018-07-17 14:56:11 +01:00
benchmarks crypto: Remove Ed25519 and Secp256k1 suffix on GenPrivKey 2018-07-20 10:44:21 -07:00
blockchain Merge remote-tracking branch 'origin/develop' into dev/refactor_crypto 2018-07-20 08:59:41 -07:00
cmd crypto: Remove Ed25519 and Secp256k1 suffix on GenPrivKey 2018-07-20 10:44:21 -07:00
config crypto: Refactor to move files out of the top level directory 2018-07-18 08:38:44 -07:00
consensus Merge remote-tracking branch 'origin/develop' into dev/refactor_crypto 2018-07-20 08:59:41 -07:00
crypto crypto: Fix package imports from the refactor 2018-07-23 16:14:21 -07:00
docs Merge remote-tracking branch 'origin/develop' into dev/refactor_crypto 2018-07-18 08:54:51 -07:00
evidence crypto: Refactor to move files out of the top level directory 2018-07-18 08:38:44 -07:00
libs crypto: Refactor to move files out of the top level directory 2018-07-18 08:38:44 -07:00
lite crypto: Remove Ed25519 and Secp256k1 suffix on GenPrivKey 2018-07-20 10:44:21 -07:00
mempool unexport DecodeMessage functions 2018-07-09 13:01:23 +04:00
networks update some docs 2018-07-02 14:20:27 -04:00
node crypto: Remove Ed25519 and Secp256k1 suffix on GenPrivKey 2018-07-20 10:44:21 -07:00
p2p crypto: Remove Ed25519 and Secp256k1 suffix on GenPrivKey 2018-07-20 10:44:21 -07:00
privval crypto: Remove Ed25519 and Secp256k1 suffix on GenPrivKey 2018-07-20 10:44:21 -07:00
proxy fix import paths 2018-07-01 22:36:49 -04:00
rpc Merge remote-tracking branch 'origin/develop' into dev/refactor_crypto 2018-07-20 08:59:41 -07:00
scripts crypto: Refactor to move files out of the top level directory 2018-07-18 08:38:44 -07:00
state crypto: Remove Ed25519 and Secp256k1 suffix on GenPrivKey 2018-07-20 10:44:21 -07:00
test tools: Remove redundant grep -v vendors/ (#1996) 2018-07-17 21:33:00 +04:00
tools crypto: Remove Ed25519 and Secp256k1 suffix on GenPrivKey 2018-07-20 10:44:21 -07:00
types crypto: Remove Ed25519 and Secp256k1 suffix on GenPrivKey 2018-07-20 10:44:21 -07:00
version crypto: Refactor to move files out of the top level directory 2018-07-18 08:38:44 -07:00
.editorconfig Revert "delete some things for the merge" 2018-07-01 22:36:13 -04:00
.gitignore Add gogoproto marshallers to proto files in order to make use of 2018-07-17 11:51:38 +01:00
CHANGELOG.md Merge remote-tracking branch 'origin/develop' into dev/refactor_crypto 2018-07-18 08:54:51 -07:00
CODE_OF_CONDUCT.md Add Code of Conduct 2017-06-19 15:46:15 +02:00
CONTRIBUTING.md contributing guide typos (#1831) 2018-06-29 11:09:16 +04:00
Gopkg.lock Merge remote-tracking branch 'origin/develop' into dev/refactor_crypto 2018-07-20 08:59:41 -07:00
Gopkg.toml Merge pull request #1742 from Liamsi/proto_files 2018-07-20 17:43:25 +02:00
LICENSE Revert "delete some things for the merge" 2018-07-01 22:36:13 -04:00
Makefile add protoc_all and protoc_grpc to .PHONY 2018-07-20 01:27:41 +04:00
README.md crypto: Refactor to move files out of the top level directory 2018-07-18 08:38:44 -07:00
ROADMAP.md version bump. add roadmap back. minor fixes 2018-05-15 22:42:29 -04:00
SECURITY.md security.md 2018-05-20 00:33:37 -04:00
Vagrantfile update Vagrantfile 2018-05-17 10:43:38 +04:00
appveyor.yml appveyor: use make 2017-12-10 20:07:44 -05:00
codecov.yml Remove pb.go files from codecov 2018-07-17 17:42:30 +01:00
docker-compose.yml Switch ports 466xx to 266xx (#1735) 2018-06-12 13:25:52 +04:00

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.

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.9 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, Read The Docs. Additional information about some - and eventually all - of the sub-projects below, can be found at Read The Docs.

Sub-projects

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

Tools

Applications

More

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

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).

Code of Conduct

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