README
¶
Tenderdash
Byzantine-Fault Tolerant State Machine Replication. Or Blockchain, for short.
| Branch | Tests | Coverage | Linting |
|---|---|---|---|
| master |  |
 |
 |
Tenderdash is a Byzantine Fault Tolerant (BFT) middleware that takes a state transition machine - written in any programming language - and securely replicates it on many machines.
Background
Tenderdash started as a fork of the Tendermint Core project and has been used in public environments such as the Cosmos Network. Although based on Tendermint, Tenderdash differs from Tendermint through its use of Dash's long-living masternode quorums (LLMQs) to support threshold signatures, quorum-based voting, and dynamic validator set rotation. These enhancements to support rapid transaction finality and maintain strong security guarantees make Tenderdash ideal for Dash Platform’s needs.
For Tendermint protocol details, refer to the Tendermint Specification. For a detailed analysis of the consensus protocol, including safety and liveness proofs, read the Tendermint paper, "The latest gossip on BFT consensus". Tendermint documentation can be found on docs.tendermint.com.
Releases
Please do not depend on master as your production branch. Use the binaries provided on the GitHub releases page instead.
Install
See the install instructions. Make sure to meet the minimum requirements if installing from source.
Minimum requirements
| Requirement | Notes |
|---|---|
| Go version | Go1.23 or higher |
Versioning
Semantic Versioning
Tenderdash uses Semantic Versioning to determine when and how the version changes.
The Tenderdash API includes all publicly exposed types, functions, and methods in non-internal Go packages as well as the types and methods accessible via the RPC interface. Breaking changes to these public APIs will be documented in the CHANGELOG.
Supported Versions
Because we are a small core team, we only ship patch updates, including security updates, to the most recent minor release and the second-most recent minor release. Consequently, we strongly recommend keeping Tenderdash up-to-date.
Resources
- The latest gossip on BFT consensus
- Master's Thesis on Tendermint
- Original Whitepaper: "Tendermint: Consensus Without Mining"
Contributing
Before contributing to the project, please take a look at the contributing guidelines and the style guide. You may also find it helpful to read the Tendermint specifications, and familiarize yourself with the Architectural Decision Records (ADRs) and Request For Comments (RFCs).
Join us
Tenderdash is maintained by Dash Core Group. If you'd like to work full-time on Tenderdash, see our Jobs page.
Directories
¶
| Path | Synopsis |
|---|---|
|
abci
|
|
|
client
Package abciclient provides an ABCI implementation in Go.
|
Package abciclient provides an ABCI implementation in Go. |
|
server
Package server is used to start a new ABCI server.
|
Package server is used to start a new ABCI server. |
|
cmd
|
|
|
merkle
Package merkle computes a deterministic minimal height Merkle tree hash.
|
Package merkle computes a deterministic minimal height Merkle tree hash. |
|
quorum/selectpeers
Package selectpeers is package contains algorithm that selects peers based on the deterministic connection selection algorithm described in DIP-6
|
Package selectpeers is package contains algorithm that selects peers based on the deterministic connection selection algorithm described in DIP-6 |
|
internal
|
|
|
blocksync
Package blocksync implements two versions of a reactor Service that are responsible for block propagation and gossip between peers.
|
Package blocksync implements two versions of a reactor Service that are responsible for block propagation and gossip between peers. |
|
eventlog
Package eventlog defines a reverse time-ordered log of events over a sliding window of time before the most recent item in the log.
|
Package eventlog defines a reverse time-ordered log of events over a sliding window of time before the most recent item in the log. |
|
eventlog/cursor
Package cursor implements time-ordered item cursors for an event log.
|
Package cursor implements time-ordered item cursors for an event log. |
|
evidence
Package evidence handles all evidence storage and gossiping from detection to block proposal.
|
Package evidence handles all evidence storage and gossiping from detection to block proposal. |
|
inspect
Package inspect provides a tool for investigating the state of a failed Tendermint node.
|
Package inspect provides a tool for investigating the state of a failed Tendermint node. |
|
jsontypes
Package jsontypes supports decoding for interface types whose concrete implementations need to be stored as JSON.
|
Package jsontypes supports decoding for interface types whose concrete implementations need to be stored as JSON. |
|
libs/confix
Package confix applies changes to a Tendermint TOML configuration file, to update configurations created with an older version of Tendermint to a compatible format for a newer version.
|
Package confix applies changes to a Tendermint TOML configuration file, to update configurations created with an older version of Tendermint to a compatible format for a newer version. |
|
libs/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. |
|
libs/queue
Package queue implements a dynamic FIFO queue with a fixed upper bound and a flexible quota mechanism to handle bursty load.
|
Package queue implements a dynamic FIFO queue with a fixed upper bound and a flexible quota mechanism to handle bursty load. |
|
p2p/pex
Package PEX (Peer exchange) handles all the logic necessary for nodes to share information about their peers to other nodes.
|
Package PEX (Peer exchange) handles all the logic necessary for nodes to share information about their peers to other nodes. |
|
pubsub
Package pubsub implements an event dispatching server with a single publisher and multiple subscriber clients.
|
Package pubsub implements an event dispatching server with a single publisher and multiple subscriber clients. |
|
pubsub/query
Package query implements the custom query format used to filter event subscriptions in Tendermint.
|
Package query implements the custom query format used to filter event subscriptions in Tendermint. |
|
pubsub/query/syntax
Package syntax defines a scanner and parser for the Tendermint event filter query language.
|
Package syntax defines a scanner and parser for the Tendermint event filter query language. |
|
rpc/core
Package core defines the Tendermint RPC endpoints.
|
Package core defines the Tendermint RPC endpoints. |
|
state/indexer
Package indexer defines Tendermint's block and transaction event indexing logic.
|
Package indexer defines Tendermint's block and transaction event indexing logic. |
|
state/indexer/sink/psql
Package psql implements an event sink backed by a PostgreSQL database.
|
Package psql implements an event sink backed by a PostgreSQL database. |
|
test/factory
Package factory provides generation code for common structs in Tendermint.
|
Package factory provides generation code for common structs in Tendermint. |
|
package light provides a light client implementation.
|
package light provides a light client implementation. |
|
Package node is the main entry point, where the tendermint node service is constructed and the implementation of that service is defined.
|
Package node is the main entry point, where the tendermint node service is constructed and the implementation of that service is defined. |
|
Package privval provides different implementations of the types.PrivValidator.
|
Package privval provides different implementations of the types.PrivValidator. |
|
proto
|
|
|
rpc
|
|
|
client/eventstream
Package eventstream implements a convenience client for the Events method of the Tendermint RPC service, allowing clients to observe a resumable stream of events matching a query.
|
Package eventstream implements a convenience client for the Events method of the Tendermint RPC service, allowing clients to observe a resumable stream of events matching a query. |
|
jsonrpc
HTTP RPC server supporting calls via uri params, jsonrpc over HTTP, and jsonrpc over websockets
|
HTTP RPC server supporting calls via uri params, jsonrpc over HTTP, and jsonrpc over websockets |
|
jsonrpc/server
Commons for HTTP handling
|
Commons for HTTP handling |
|
scripts
|
|
|
condiff
Program condiff performs a keyspace diff on two TOML documents.
|
Program condiff performs a keyspace diff on two TOML documents. |
|
confix
Program confix applies changes to a Tendermint TOML configuration file, to update configurations created with an older version of Tendermint to a compatible format for a newer version.
|
Program confix applies changes to a Tendermint TOML configuration file, to update configurations created with an older version of Tendermint to a compatible format for a newer version. |
|
estream
Program estream is a manual testing tool for polling the event stream of a running Tendermint consensus node.
|
Program estream is a manual testing tool for polling the event stream of a running Tendermint consensus node. |
|
keymigrate
Package keymigrate translates all legacy formatted keys to their new components.
|
Package keymigrate translates all legacy formatted keys to their new components. |
|
linkpatch
Program linkpatch rewrites absolute URLs pointing to targets in GitHub in Markdown link tags to target a different branch.
|
Program linkpatch rewrites absolute URLs pointing to targets in GitHub in Markdown link tags to target a different branch. |
|
metricsgen
metricsgen is a code generation tool for creating constructors for Tendermint metrics types.
|
metricsgen is a code generation tool for creating constructors for Tendermint metrics types. |
|
metricsgen/metricsdiff
metricsdiff is a tool for generating a diff between two different files containing prometheus metrics.
|
metricsdiff is a tool for generating a diff between two different files containing prometheus metrics. |
|
scmigrate
Package scmigrate implements a migration for SeenCommit data between 0.34 and 0.35
|
Package scmigrate implements a migration for SeenCommit data between 0.34 and 0.35 |
|
test
|
|