Go to file
Ethan Buchman 2df137193c security.md 2018-05-20 00:33:37 -04:00
.circleci move a file to remove a directory 2018-05-18 13:37:58 -04:00
.github add 2 more points to ISSUE_TEMPLATE 2018-03-08 18:53:11 +04:00
DOCKER Added tendermint/testing docker image description 2018-05-14 12:24:54 -04:00
benchmarks Fix validValue rule 2018-05-14 16:17:21 -04:00
blockchain fix 2018-05-17 15:24:37 -04:00
cmd Fix validValue rule 2018-05-14 16:17:21 -04:00
config bound the mempool 2018-05-18 10:45:51 +04:00
consensus fix 2018-05-17 15:24:37 -04:00
docs docs/spec: blockchain and consensus dirs 2018-05-20 00:28:47 -04:00
evidence check max msg size in DecodeMessage 2018-04-09 15:18:47 +03:00
lite 1417 status response format (#1424) 2018-04-11 10:38:34 +02:00
mempool remove TODO 2018-05-18 10:48:13 +04:00
networks networks: update readmes 2018-05-19 23:35:45 -04:00
node simplify indexer service main loop 2018-05-17 10:00:59 +04:00
p2p nice output for msgBytes 2018-05-18 12:45:09 +04:00
proxy return back dummy & persistent_dummy as options for proxy_app 2018-03-01 11:54:08 +04:00
rpc Fix validValue rule 2018-05-14 16:17:21 -04:00
scripts fix addresses 2018-04-07 23:13:41 +03:00
state simplify indexer service main loop 2018-05-17 10:00:59 +04:00
test rm unused file, fix docker-compose.yml 2018-05-18 14:12:01 -04:00
types AddPart always verifies 2018-05-17 13:17:50 -04:00
version version bump 2018-05-17 22:28:53 -04:00
.editorconfig merge 2 rules in .editorconfig 2017-12-04 15:01:28 -06:00
.gitignore docs: build updates 2018-04-03 04:48:40 -07:00
CHANGELOG.md version bump 2018-05-17 22:28:53 -04:00
CODE_OF_CONDUCT.md Add Code of Conduct 2017-06-19 15:46:15 +02:00
CONTRIBUTING.md style fixes from @xla 2018-02-28 12:24:26 +04:00
Gopkg.lock Expose peer stats for dump_consensus_state 2018-05-10 22:43:21 -07:00
Gopkg.toml Expose peer stats for dump_consensus_state 2018-05-10 22:43:21 -07:00
LICENSE GPLv3 -> Apache2.0 2016-07-18 11:51:37 -04:00
Makefile update networks/local readme 2018-05-19 23:21:35 -04:00
README.md security.md 2018-05-20 00:33:37 -04: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 [codecov] ignore docs, scripts and DOCKER dirs 2018-04-02 11:23:56 +02:00
docker-compose.yml rm unused file, fix docker-compose.yml 2018-05-18 14:12:01 -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 protocol details, see the specification.

To report a security vulnerability, see our bug bounty program.

Minimum requirements

Requirement Notes
Go version Go1.9 or higher

Install

See the install instructions

Quick Start

Resources

Tendermint Core

For more, 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.