README
¶
Tendermint
Byzantine-Fault Tolerant State Machine Replication. Or Blockchain for short.
| Branch | Tests | Coverage |
|---|---|---|
| master |  |
 |
| develop |  |
 |
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/AeReach/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
- 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.), 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.
Directories
¶
| Path | Synopsis |
|---|---|
|
abci
|
|
|
cmd/abci-cli
command
|
|
|
tests/benchmarks/parallel
command
|
|
|
tests/benchmarks/simple
command
|
|
|
tests/test_app
command
|
|
|
tests/test_sc
command
bcchain v2.0重大问题和修订方案1.1解决方案3 客户端测试连接数 bcchain v2.0重大问题和修订方案1.1解决方案3 客户端测试连接数 bcchain v2.0重大问题和修订方案1.1解决方案3 客户端测试脏数据 bcchain v2.0重大问题和修订方案1.1解决方案3 客户端测试正常数据 bcchain v2.0重大问题和修订方案1.1解决方案3 服务端
|
bcchain v2.0重大问题和修订方案1.1解决方案3 客户端测试连接数 bcchain v2.0重大问题和修订方案1.1解决方案3 客户端测试连接数 bcchain v2.0重大问题和修订方案1.1解决方案3 客户端测试脏数据 bcchain v2.0重大问题和修订方案1.1解决方案3 客户端测试正常数据 bcchain v2.0重大问题和修订方案1.1解决方案3 服务端 |
|
types
Package types is a generated protocol buffer package.
|
Package types is a generated protocol buffer package. |
|
proto
Package test is a generated protocol buffer package.
|
Package test is a generated protocol buffer package. |
|
simu
command
|
|
|
cmd
|
|
|
p2p_ping
command
|
|
|
priv_val_server
command
|
|
|
tendermint
command
|
|
|
consensus
|
|
|
docs
|
|
|
specification/new-spec/scripts
command
|
|
|
Package ed25519 implements the Ed25519 signature algorithm.
|
Package ed25519 implements the Ed25519 signature algorithm. |
|
edwards25519
Package edwards25519 implements operations in GF(2**255-19) and on an Edwards curve that is isomorphic to curve25519.
|
Package edwards25519 implements operations in GF(2**255-19) and on an Edwards curve that is isomorphic to curve25519. |
|
Amino is an encoding library that can handle interfaces (like protobuf "oneof") well.
|
Amino is an encoding library that can handle interfaces (like protobuf "oneof") well. |
|
cmd
command
|
|
|
tests/fuzz/binary/init-corpus
command
|
|
|
go-crypto is a customized/convenience cryptography package for supporting Tendermint.
|
go-crypto is a customized/convenience cryptography package for supporting Tendermint. |
|
go-wire is our custom codec package for serializing and deserializing data and structures as binary and JSON blobs.
|
go-wire is our custom codec package for serializing and deserializing data and structures as binary and JSON blobs. |
|
cmd/wire
command
|
|
|
data
Data is designed to provide a standard interface and helper functions to easily allow serialization and deserialization of your data structures in both binary and json representations.
|
Data is designed to provide a standard interface and helper functions to easily allow serialization and deserialization of your data structures in both binary and json representations. |
|
data/base58
Package base58 provides base58-check encoding.
|
Package base58 provides base58-check encoding. |
|
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. |
|
files
Package files defines a Provider that stores all data in the filesystem We assume the same validator hash may be reused by many different headers/Commits, and thus store it separately.
|
Package files defines a Provider that stores all data in the filesystem We assume the same validator hash may be reused by many different headers/Commits, and thus store it separately. |
|
conn
Uses nacl's secret_box to encrypt a net.Conn.
|
Uses nacl's secret_box to encrypt a net.Conn. |
|
upnp
Taken from taipei-torrent.
|
Taken from taipei-torrent. |
|
rpc
|
|
|
client
package client provides a general purpose interface (Client) for connecting to a tendermint node, as well as higher-level functionality.
|
package client provides a general purpose interface (Client) for connecting to a tendermint node, as well as higher-level functionality. |
|
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
# Introduction Tendermint supports the following RPC protocols: * URI over HTTP * JSONRPC over HTTP * JSONRPC over websockets Tendermint RPC is built using [our own RPC library](https://github.com/AeReach/tendermint/tree/master/rpc/lib).
|
# Introduction Tendermint supports the following RPC protocols: * URI over HTTP * JSONRPC over HTTP * JSONRPC over websockets Tendermint RPC is built using [our own RPC library](https://github.com/AeReach/tendermint/tree/master/rpc/lib). |
|
grpc
Package core_grpc is a generated protocol buffer package.
|
Package core_grpc is a generated protocol buffer package. |
|
wal2json
command
|
|
|
test
|
|
|
app
command
|
|
|
tmlibs
|
|
|
common
Package common is a generated protocol buffer package.
|
Package common is a generated protocol buffer package. |
|
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. |
|
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: abci.invoice.number=22 AND abci.invoice.owner=Ivan See query.peg for the grammar, which is a https://en.wikipedia.org/wiki/Parsing_expression_grammar.
|
Package query provides a parser for a custom query format: abci.invoice.number=22 AND abci.invoice.owner=Ivan See query.peg for the grammar, which is a https://en.wikipedia.org/wiki/Parsing_expression_grammar. |