Go to file
Anton Kaliaev e01650f21d
fix Dockerfile.develop
2018-02-27 18:02:40 +04:00
.github Create PULL_REQUEST_TEMPLATE.md 2018-01-18 13:53:18 -05:00
DOCKER fix Dockerfile.develop 2018-02-27 18:02:40 +04:00
benchmarks rename dummy to kvstore (#1223) 2018-02-27 18:01:10 +04:00
blockchain fixes from Jae's review 2018-02-12 14:32:09 +04:00
cmd/tendermint rename dummy to kvstore (#1223) 2018-02-27 18:01:10 +04:00
config rename dummy to kvstore (#1223) 2018-02-27 18:01:10 +04:00
consensus rename dummy to kvstore (#1223) 2018-02-27 18:01:10 +04:00
docs ditch glide 2018-02-27 18:02:40 +04:00
evidence fixes from Jae's review 2018-02-12 14:32:09 +04:00
lite rename dummy to kvstore (#1223) 2018-02-27 18:01:10 +04:00
mempool rename dummy to kvstore (#1223) 2018-02-27 18:01:10 +04:00
node p2p: introduce peerConn to simplify peer creation (#1226) 2018-02-27 15:54:40 +04:00
p2p rename dummy to kvstore (#1223) 2018-02-27 18:01:10 +04:00
proxy rename dummy to kvstore (#1223) 2018-02-27 18:01:10 +04:00
rpc rename dummy to kvstore (#1223) 2018-02-27 18:01:10 +04:00
scripts ditch glide 2018-02-27 18:02:40 +04:00
state rename dummy to kvstore (#1223) 2018-02-27 18:01:10 +04:00
test ditch glide 2018-02-27 18:02:40 +04:00
types p2p: introduce peerConn to simplify peer creation (#1226) 2018-02-27 15:54:40 +04:00
version changelog date and version 2018-02-19 17:35:46 -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 Fix vagrantfile 2018-01-26 01:16:07 -05:00
CHANGELOG.md p2p: introduce peerConn to simplify peer creation (#1226) 2018-02-27 15:54:40 +04:00
CODE_OF_CONDUCT.md Add Code of Conduct 2017-06-19 15:46:15 +02:00
CONTRIBUTING.md ditch glide 2018-02-27 18:02:40 +04:00
Gopkg.lock Switch to dep from glide for dependency management (#1243) 2018-02-27 15:59:50 +04:00
Gopkg.toml Switch to dep from glide for dependency management (#1243) 2018-02-27 15:59:50 +04:00
LICENSE GPLv3 -> Apache2.0 2016-07-18 11:51:37 -04:00
Makefile ditch glide 2018-02-27 18:02:40 +04:00
README.md README: document the minimum Go version 2017-12-28 23:26:45 -07:00
Vagrantfile deterministic tooling for releases 2018-02-06 12:46:13 +04:00
appveyor.yml appveyor: use make 2017-12-10 20:07:44 -05:00
circle.yml mercy for developers with slow Internet 2018-01-23 20:37:38 +04: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.

Minimum requirements

Requirement Notes
Go version Go1.9 or higher

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.