Repository files navigation

Tendermint in Rust withTLA+ specifications.

Tendermint is a high-performance blockchain consensus engine for Byzantine faulttolerant applications written in any programming language.

tendermint-rs has been tested for compatibility with Tendermint Core v0.34.21.

Tested against the latest stable version of Rust. May work with older versions.

We do our best to followSemantic Versioning. However, aswe are pre-v1.0.0, we use the MINOR version to refer to breaking changes and thePATCH version for features, improvements, and fixes.

We use the same version for all crates and release them collectively.

See each component for the relevant documentation.

Libraries:

• tendermint - Tendermint data structures and serialization
• tendermint-abci - A lightweight, low-level framework for buildingTendermint ABCI applications in Rust
• tendermint-light-client - Tendermint light client libraryfor verifying signed headers and tracking validator set changes
• tendermint-light-client-detector - Library fordetecting and reporting attacks against the Tendermint light client
• tendermint-light-client-cli - CLI for the light client,for verifying headers, detecting attacks and reporting them.
• tendermint-light-client-js - Low-level WASM interface forinteracting with the Tendermint light client verification functionality
• tendermint-p2p - At present this primarily provides the ability toconnect to Tendermint nodes via Tendermint'ssecret connection
• tendermint-proto - Protobuf data structures (generated using Prost)for wire-level interaction with Tendermint
• tendermint-rpc - Tendermint RPC client and response types

Release tags can be found onGitHub.

Crates are released oncrates.io.

The Tendermint protocols are specified in English in thetendermint/tendermintrepo. Any protocolchanges or clarifications should be contributed there.

This repo contains the TLA+ specifications and Rust implementations for variouscomponents of Tendermint. See theCONTRIBUTING.md to startcontributing.

Software, Specs, and Documentation

• Tendermint Datastructures Spec
• Tendermint in Go
• Docs for Tendermint in Go

Papers

• The latest gossip on BFT consensus
• Ethan Buchman's Master's Thesis on Tendermint

Copyright © 2020 Informal Systems and contributors

Licensed under the Apache License, Version 2.0 (the "License");you may not use the files in this repository except in compliance with the License.You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.