Go to file
Ethan Buchman 6884463ba2 update changelog [ci skip] 2017-12-06 03:38:03 -05:00
.github CODEOWNERS file 2017-10-04 23:44:55 -04:00
DOCKER update readme [ci skip] 2017-11-10 15:38:32 -05:00
benchmarks fixes and version bump 2017-12-06 03:33:03 -05:00
blockchain use rand.Int63n, remove underflow check, remove unnecessary cast 2017-12-01 19:22:18 -06:00
cmd/tendermint service#Start, service#Stop signatures were changed 2017-11-29 10:38:58 -06:00
config config variable to index all tags 2017-11-30 20:02:39 -06:00
consensus Merge pull request #918 from tendermint/abci-update 2017-12-03 01:36:59 -05:00
docs Merge pull request #912 from bluecollarcoding/fix/docs 2017-12-01 02:57:32 -05:00
lite int64 height 2017-12-01 19:04:53 -06:00
mempool mempool: assert -> require in test 2017-12-02 23:41:09 -05:00
node update for new abci int types 2017-12-02 01:47:55 -05:00
p2p Merge pull request #917 from tendermint/trust-metric-cleanup 2017-12-06 02:11:38 -05:00
proxy fixes from my own review 2017-11-29 14:24:18 -06:00
rpc fixes and version bump 2017-12-06 03:33:03 -05:00
scripts remove GitDescribe - no such variable defined in version package 2017-12-04 18:19:11 -06:00
state update for new abci int types 2017-12-02 01:47:55 -05:00
test get_vendor_deps does not require all the tools 2017-12-04 18:19:11 -06:00
types types: fix for broken customtype int in gogo 2017-12-02 12:00:46 -05:00
version fixes and version bump 2017-12-06 03:33:03 -05:00
.codecov.yml Update .codecov.yml 2017-11-30 19:01:50 +00:00
.editorconfig merge 2 rules in .editorconfig 2017-12-04 15:01:28 -06:00
.gitignore fixes per Bucky's review 2017-10-24 12:14:21 +04:00
CHANGELOG.md update changelog [ci skip] 2017-12-06 03:38:03 -05:00
CODE_OF_CONDUCT.md Add Code of Conduct 2017-06-19 15:46:15 +02:00
CONTRIBUTING.md Merge branch 'master' into develop 2017-11-28 04:39:41 +00:00
LICENSE GPLv3 -> Apache2.0 2016-07-18 11:51:37 -04:00
Makefile add missing get_vendor_deps to "make all" 2017-12-04 19:04:15 -06:00
README.md add Go version badge to README [ci skip] 2017-11-15 10:22:02 -06:00
Vagrantfile go requires Git (Fixes #879) 2017-11-23 16:55:57 -06:00
circle.yml run metalinter in make test and run_test.sh 2017-11-27 22:39:12 +00:00
glide.lock fixes and version bump 2017-12-06 03:33:03 -05:00
glide.yaml changelog; minor stuff; update glide 2017-12-06 02:45:38 -05:00

README.md

Tendermint

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

version API Reference Go version Rocket.Chat license

Branch Tests Coverage
master CircleCI codecov
develop CircleCI codecov

NOTE: This is alpha software. Please contact us if you intend to run it in production.

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 more information, from introduction to install to application development, Read The Docs.

Install

To download pre-built binaries, see our downloads page.

To install from source, you should be able to:

go get -u github.com/tendermint/tendermint/cmd/tendermint

For more details (or if it fails), read the docs.

Resources

Tendermint Core

All resources involving the use of, building application on, or developing for, tendermint, can be found at Read The Docs. Additional information about some - and eventually all - of the sub-projects below, can be found at Read The Docs.

Sub-projects

  • ABCI, the Application Blockchain Interface
  • Go-Wire, a deterministic serialization library
  • Go-Crypto, an elliptic curve cryptography library
  • TmLibs, an assortment of Go libraries used internally
  • 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.), as well as parts of the following packages:

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