tendermint-rs

[Tendermint] in Rust with TLA+ specifications.

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

Requirements

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

Versioning

Each of the following branches targets a specific version of Tendermint Core:

| tendermint-rs branch | tendermint-rs version | Tendermint version | | -------------------- | --------------------- | ------------------ | | master | v0.24.x | v0.35.x | | v0.23.x | v0.23.x | v0.34.x |

We will do our best to support one version behind the latest official release of Tendermint Core (e.g. if v0.35.x is the latest release, we will aim to support v0.34.x as well).

Semantic Versioning

We do our best to follow Semantic Versioning. However, as we are pre-v1.0.0, we use the MINOR version to refer to breaking changes and the PATCH version for features, improvements, and fixes.

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

If you are using the v0.23.x series of tendermint-rs, however, please pin your dependencies to a specific patch version. We may need to introduce breaking changes to this series in patches (e.g. if critical security updates require it), but we will do our best to avoid doing so.

Documentation

See each component for the relevant documentation.

Libraries:

• tendermint - Tendermint data structures and serialization
• tendermint-abci - A lightweight, low-level framework for building Tendermint ABCI applications in Rust
• tendermint-light-client - Tendermint light client library for verifying signed headers, tracking validator set changes, and detecting forks
• tendermint-light-client-js - Low-level WASM interface for interacting with the Tendermint light client verification functionality
• tendermint-p2p - At present this primarily provides the ability to connect to Tendermint nodes via Tendermint's secret connection.
• tendermint-proto - Protobuf data structures (generated using Prost) for wire-level interaction with Tendermint
• tendermint-rpc - Tendermint RPC client and response types

Releases

Release tags can be found on GitHub.

Crates are released on crates.io.

Contributing

The Tendermint protocols are specified in English in the tendermint/spec repo. Any protocol changes or clarifications should be contributed there.

This repo contains the TLA+ specifications and Rust implementations for various components of Tendermint. See the CONTRIBUTING.md to start contributing.

Resources

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

License

Copyright © 2020 Informal Systems

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, software distributed 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 and limitations under the License.