tendermint

module
v0.26.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 27, 2018 License: Apache-2.0

README

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.

For detailed analysis of the consensus protocol, including safety and liveness proofs, see our recent paper, "The latest gossip on BFT consensus".

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 and join the chat.

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.10 or higher

Documentation

Complete documentation can be found on the website.

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, see the documentation which is also hosted at: https://tendermint.com/docs/

Tools

Benchmarking and monitoring is provided by tm-bench and tm-monitor, respectively. Their code is found here and these binaries need to be built seperately. Additional documentation is found here.

Sub-projects
  • Amino, a reflection-based improvement on proto3
  • IAVL, Merkleized IAVL+ Tree implementation
Applications
Research

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
  • libs
    • bech32
    • common
    • db
    • errors
    • log

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).

For more information on upgrading, see here

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
version
proto
Package test is a generated protocol buffer package.
 Package test is a generated protocol buffer package.
simu
cmd
priv_val_server
tendermint
tendermint/commands
types
Ripemd160
 Ripemd160
armor
ed25519
encoding/amino
internal/benchmarking
merkle
Package merkle computes a deterministic minimal height Merkle tree hash.
 Package merkle computes a deterministic minimal height Merkle tree hash.
multisig
multisig/bitarray
secp256k1
tmhash
xchacha20poly1305
Package xchacha20poly1305 creates an AEAD using hchacha, chacha, and poly1305 This allows for randomized nonces to be used in conjunction with chacha.
 Package xchacha20poly1305 creates an AEAD using hchacha, chacha, and poly1305 This allows for randomized nonces to be used in conjunction with chacha.
xsalsa20symmetric
docs
spec/scripts
libs
autofile
autofile/cmd
bech32
cli
cli/flags
clist
common
nolint
 nolint
db
db/remotedb
remotedb is a package for connecting to distributed Tendermint db.DB instances.
 remotedb is a package for connecting to distributed Tendermint db.DB instances.
db/remotedb/grpcdb
grpcdb is the distribution of Tendermint's db.DB instances using the gRPC transport to decouple local db.DB usages from applications, to using them over a network in a highly performant manner.
 grpcdb is the distribution of Tendermint's db.DB instances using the gRPC transport to decouple local db.DB usages from applications, to using them over a network in a highly performant manner.
db/remotedb/proto
Package protodb is a generated protocol buffer package.
 Package protodb is a generated protocol buffer package.
errors
Package errors contains errors that are thrown across packages.
 Package errors contains errors that are thrown across packages.
events
Package events - Pub-Sub in go with event caching
 Package events - Pub-Sub in go with event caching
fail
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
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 Tendermint 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 Tendermint client.
errors
proxy
p2p
conn
dummy
pex
trust
upnp
Taken from taipei-torrent.
 Taken from taipei-torrent.
rpc
client
client/mock
core
core/types
grpc
nolint
 nolint
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
json2wal
wal2json
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
proto3
time

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.