tendermint

module

v0.22.8-autodraft Latest Latest Go to latest Published: Jul 27, 2018 License: Apache-2.0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/iov-one/tendermint

README ¶

Tendermint

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

Branch	Tests	Coverage
master
develop

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

Deployment, Benchmarking, and Monitoring

Applications

Cosmos SDK; a cryptocurrency application framework
Ethermint; Ethereum on Tendermint
Many more

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.

Directories ¶

Path	Synopsis
abci
client
cmd/abci-cli
example
example/code
example/counter
example/kvstore
server
tests
tests/benchmarks
tests/benchmarks/parallel
tests/benchmarks/simple
tests/server
tests/test_app
types Package types is a generated protocol buffer package.	Package types is a generated protocol buffer package.
version
benchmarks
proto Package test is a generated protocol buffer package.	Package test is a generated protocol buffer package.
simu
blockchain
cmd
priv_val_server
tendermint
tendermint/commands
config
consensus
types
crypto Ripemd160	Ripemd160
armor
ed25519
encoding/amino
hkdfchacha20poly1305 Package hkdfchacha20poly1305 creates an AEAD using hkdf, chacha20, and poly1305 When sealing and opening, the hkdf is used to obtain the nonce and subkey for chacha20.	Package hkdfchacha20poly1305 creates an AEAD using hkdf, chacha20, and poly1305 When sealing and opening, the hkdf is used to obtain the nonce and subkey for chacha20.
merkle Package merkle computes a deterministic minimal height Merkle tree hash.	Package merkle computes a deterministic minimal height Merkle tree hash.
secp256k1
tmhash
xsalsa20symmetric
docs
spec/scripts
evidence
libs
autofile
autofile/cmd
bech32
cli
cli/flags
clist
common Package common is a generated protocol buffer package.	Package common is a generated protocol buffer package.
db
db/remotedb
db/remotedb/grpcdb
db/remotedb/proto
events Pub-Sub in go with event caching	Pub-Sub in go with event caching
flowrate Package flowrate provides the tools for monitoring and limiting the flow rate of an arbitrary data stream.	Package flowrate provides the tools for monitoring and limiting the flow rate of an arbitrary data stream.
log
pubsub Package pubsub implements a pub-sub model with a single publisher (Server) and multiple subscribers (clients).	Package pubsub implements a pub-sub model with a single publisher (Server) and multiple subscribers (clients).
pubsub/query Package query provides a parser for a custom query format:	Package query provides a parser for a custom query format:
pubsub/query/fuzz_test
test
version
lite Package lite allows you to securely validate headers without a full node.	Package lite allows you to securely validate headers without a full node.
client Package client defines a provider that uses a rpcclient to get information, which is used to get new headers and validators directly from a node.	Package client defines a provider that uses a rpcclient to get information, which is used to get new headers and validators directly from a node.
errors
files Package files defines a Provider that stores all data in the filesystem	Package files defines a Provider that stores all data in the filesystem
proxy
mempool
node
p2p
conn Uses nacl's secret_box to encrypt a net.Conn.	Uses nacl's secret_box to encrypt a net.Conn.
dummy
pex
trust
upnp Taken from taipei-torrent.	Taken from taipei-torrent.
privval
proxy
rpc
client
client/mock package mock returns a Client implementation that accepts various (mock) implementations of the various methods.	package mock returns a Client implementation that accepts various (mock) implementations of the various methods.
core
core/types
grpc Package core_grpc is a generated protocol buffer package.	Package core_grpc is a generated protocol buffer package.
lib HTTP RPC server supporting calls via uri params, jsonrpc, and jsonrpc over websockets	HTTP RPC server supporting calls via uri params, jsonrpc, and jsonrpc over websockets
lib/client
lib/server Commons for HTTP handling	Commons for HTTP handling
lib/test
lib/types
test
scripts
wal2json
state
txindex
txindex/kv
txindex/null
test
app
tools
tm-bench
tm-monitor
tm-monitor/eventmeter eventmeter - generic system to subscribe to events and record their frequency.	eventmeter - generic system to subscribe to events and record their frequency.
tm-monitor/mock
tm-monitor/monitor
types
proto3 Package proto3 is a generated protocol buffer package.	Package proto3 is a generated protocol buffer package.
version

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL