Skip to content

Latest commit

 

History

History
120 lines (82 loc) · 4.22 KB

README.md

File metadata and controls

120 lines (82 loc) · 4.22 KB
Raw

tendermint.rs

Crate Docs Build Status Audit Status Apache 2.0 Licensed Rust Stable

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.

Compatible with the v0.34 series of Tendermint Core.

Documentation

See each component for the relevant documentation.

Libraries:

  • tendermint - Tendermint data structures and serialization
  • tendermint-rpc - Tendermint RPC client and response types
  • light-client - Tendermint light client library for verifying signed headers, tracking validator set changes, and detecting forks

Binaries:

  • light-node - Tendermint light node to synchronize with a blockchain using the light client

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.

Versioning

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.

Resources

Software, Specs, and Documentation

Papers

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.