You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Zach Ramsay ccaad06eb5 lint markdown 6 years ago
.circleci abci: Add comment for doc update 6 years ago
.github Update ISSUE_TEMPLATE to mention using pastebin (#1832) 6 years ago
DOCKER Switch ports 466xx to 266xx (#1735) 6 years ago
abci abci spec is in docs/abci-spec.md, closes #1847 6 years ago
benchmarks fix import paths 6 years ago
blockchain fix import paths 6 years ago
cmd fix import paths 6 years ago
config p2p: external address 6 years ago
consensus wait until WAL closes the autogroup 6 years ago
crypto cleanup repo merge artifacts, closes #1873, starts #1793 6 years ago
docs lint markdown 6 years ago
evidence fix import paths 6 years ago
libs Merge pull request #1862 from tendermint/zramsay-patch-1 6 years ago
lite fix import paths 6 years ago
mempool fix import paths 6 years ago
networks update some docs 6 years ago
node fixes from review 6 years ago
p2p add test 6 years ago
privval overwrite pubkey and address for convenience 6 years ago
proxy fix import paths 6 years ago
rpc fix import paths 6 years ago
scripts fix import paths 6 years ago
state state: Format panics 6 years ago
test ci: Setup abci in dependency step 6 years ago
types RIPEMD160 -> SHA256 6 years ago
version dev version bump 6 years ago
.editorconfig merge 2 rules in .editorconfig 7 years ago
.gitignore docs: update abci links (#1796) 6 years ago
CHANGELOG.md dev version bump 6 years ago
CODE_OF_CONDUCT.md Add Code of Conduct 7 years ago
CONTRIBUTING.md contributing guide typos (#1831) 6 years ago
Gopkg.lock RIPEMD160 -> SHA256 6 years ago
Gopkg.toml update grpc version. fix remotedb tests 6 years ago
LICENSE GPLv3 -> Apache2.0 8 years ago
Makefile generate RPC docs using Slate (#1612) 6 years ago
README.md update some docs 6 years ago
ROADMAP.md version bump. add roadmap back. minor fixes 6 years ago
SECURITY.md security.md 6 years ago
Vagrantfile update Vagrantfile 6 years ago
appveyor.yml appveyor: use make 7 years ago
codecov.yml [codecov] ignore docs, scripts and DOCKER dirs 6 years ago
docker-compose.yml Switch ports 466xx to 266xx (#1735) 6 years ago

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.