cometbft-rs

CometBFT client framework in Rust with TLA+ specifications.

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

CometBFT Compatibility

cometbft-rs has been tested for compatibility with CometBFT v0.34.x, v0.37.x and v0.38.x.

Requirements

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

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.

Documentation

See each component for the relevant documentation.

Libraries:

• cometbft - CometBFT
• cometbft-light-client - CometBFT light client library for verifying signed headers and tracking validator set changes
• cometbft-light-client-detector - Library for detecting and reporting attacks against the CometBFT light client
• cometbft-light-client-cli - CLI for the light client, for verifying headers, detecting attacks and reporting them.
• cometbft-light-client-js - Low-level WASM interface for interacting with the CometBFT light client verification functionality
• cometbft-proto - Protobuf data structures (generated using Prost) for wire-level interaction with CometBFT
• cometbft-rpc - CometBFT RPC client and response types

Releases

Release tags can be found on GitHub.

Crates are released on crates.io.

Contributing

The CometBFT protocols are specified in English in the cometbft/cometbft repo. Any protocol changes or clarifications should be contributed there.

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

Resources

Software, Specs, and Documentation

• CometBFT Datastructures Spec
• CometBFT in Go
• Docs for CometBFT in Go

Papers

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

License

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, 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.