Rust crates for interacting with Tendermint: a high-performance blockchain consensus engine that powers Byzantine fault tolerant applications written in any programming language.
Also includes TLA+ specifications.
Release tags can be found on Github.
Releases for each crate are published to crates.io:
- tendermint - Tendermint data structures and serialization
- tendermint-rpc - Tendermint RPC client and response types
The following crates have not been published to crates.io yet:
- light-client - Tendermint light client library for verifying signed headers, tracking validator set changes, and detecting forks
- light-node - Tendermint light client binary
Requires Rust 1.39+
See documentation on crates.io.
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. If you're interested in contributing, please comment on an issue or open a new one!
We 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.
Only the following crates are covered by SemVer guarantees:
- tendermint
- tendermint-rpc
Other crates may change arbitrarily with every release for now.
We use the same version for all crates and release them collectively.
Software, Specs, and Documentation
Papers
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.