Go to file
Zach Ramsay f23d47e5d2 upnp: keep a link 2017-10-04 17:19:49 -04:00
.github add ISSUE_TEMPLATE for github [ci skip] [circle skip] 2017-02-03 13:07:59 +04:00
DOCKER update docker readme [ci skip] 2017-10-02 12:59:32 -04:00
benchmarks all: no more anonymous imports 2017-10-04 16:40:45 -04:00
blockchain all: no more anonymous imports 2017-10-04 16:40:45 -04:00
cmd/tendermint all: no more anonymous imports 2017-10-04 16:40:45 -04:00
config Amount -> Power. Closes #166 2017-09-21 14:59:27 -04:00
consensus all: no more anonymous imports 2017-10-04 16:40:45 -04:00
docs Merge pull request #704 from tendermint/no-empty-docs 2017-10-03 23:56:05 -04:00
mempool peer interface 2017-09-15 18:40:59 -04:00
node all: no more anonymous imports 2017-10-04 16:40:45 -04:00
p2p upnp: keep a link 2017-10-04 17:19:49 -04:00
proxy abci.Info takes a struct; less merkleeyes 2017-09-22 11:42:40 -04:00
rpc all: no more anonymous imports 2017-10-04 16:40:45 -04:00
scripts release script [ci skip] 2017-10-02 13:00:20 -04:00
state all: no more anonymous imports 2017-10-04 16:40:45 -04:00
test bump up Golang version to 1.9.0 2017-10-02 12:59:32 -04:00
types all: no more anonymous imports 2017-10-04 16:40:45 -04:00
version version bump 2017-09-22 11:44:57 -04:00
.codecov.yml test: remove codecov patch threshold 2016-12-20 01:47:59 -05:00
.editorconfig [.editorconfig] add rule for .proto files [ci skip] 2017-07-19 12:29:10 +03:00
.gitignore Add extra memory to virtual machine and add coverage report to gitignore. 2017-05-01 17:29:44 +02:00
CHANGELOG.md changelog: add genesis amount->power 2017-10-02 14:28:04 -04:00
CODE_OF_CONDUCT.md Add Code of Conduct 2017-06-19 15:46:15 +02:00
CONTRIBUTING.md readme & al., update links to docs 2017-09-18 16:23:22 -04:00
INSTALL.md cleanup CONTRIBUTING.md, part of https://github.com/zramsay/tendermint/issues/7 2017-07-28 16:45:03 -04:00
LICENSE GPLv3 -> Apache2.0 2016-07-18 11:51:37 -04:00
Makefile release script [ci skip] 2017-10-02 13:00:20 -04:00
README.md readme points to ecosystem doc; add lotion, clean up 2017-10-02 23:46:35 -04:00
Vagrantfile bump up Golang version to 1.9.0 2017-10-02 12:59:32 -04:00
circle.yml collect and add docker logs to CircleCI artifacts (Refs #387) 2017-02-14 19:02:11 +04:00
glide.lock glide: update for autofile fix 2017-10-02 23:34:02 -04:00
glide.yaml glide: update for autofile fix 2017-10-02 23:34:02 -04:00

README.md

Tendermint

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

version API Reference 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.