zolfa
/
tendermint
1
0
Fork 0
Code Issues 0 Pull Requests 0 Projects 0 Releases 221 Wiki Activity
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.
3626 Commits
183 Branches
291 MiB
 
 
 
 
 
 
Tree: 390b592dec
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '390b592dec'
${ noResults }
tendermint/README.md

5.4 KiB
Raw Blame History

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 installation and application development, Read The Docs.

For protocol details, see the specification.

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

To use Tendermint, build apps on it, or develop it, 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.