https://github.com/dashpay/rs-tenderdash-abci
Application Blockchain Interface library written in Rust.
https://github.com/dashpay/rs-tenderdash-abci
Last synced: 5 months ago
JSON representation
Application Blockchain Interface library written in Rust.
- Host: GitHub
- URL: https://github.com/dashpay/rs-tenderdash-abci
- Owner: dashpay
- Created: 2023-02-28T13:44:15.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2026-01-20T12:50:40.000Z (5 months ago)
- Last Synced: 2026-01-20T19:49:52.227Z (5 months ago)
- Language: Rust
- Size: 528 KB
- Stars: 8
- Watchers: 6
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Rust bindings and server for Tenderdash ABCI++ protocol
## Introduction
This repository contains Rust bindings for Tenderdash. It includes:
* data types, requests and responses required on [Tenderdash]
* ABCI++ protocol server, supporting **Unix sockets** and **TCP** connections
* [tonic](https://docs.rs/tonic/latest/tonic/)-based ABCI++ protocol client/server, supporting grpc connections
## Structure
The repository contains the following crates:
* [tenderdash-abci](./abci/) - main crate, including ABCI++ socket and tcp server implementation, `Application` trait and re-exporting `tenderdash-proto` crate
* [tenderdash-proto](./proto/) - ABCI++ messages and data types definitions, and gRPC client/server implementation, generated based on Tenderdash protobuf specifications
* [tenderdash-proto-compiler](./proto-compiler/) - an internal tool that fetches tenderdash repository and converts protobuf files to Rust
## Version Compatibility
Versioning of this library follows the Semantic Versioning 2.0.0 specification. Specifically, it consists of
`MAJOR.MINOR.PATCH`.
This library also includes built-in support for ABCI protocol version verification. The ABCI protocol version, as defined in Tenderdash's [version.go](https://github.com/dashpay/tenderdash/blob/HEAD/version/version.go) under the `ABCISemVer` constant, must align with the ABCI protocol version of this library. You can find the library's ABCI protocol version in [proto/src/tenderdash.rs](proto/src/tenderdash.rs) under the `ABCI_VERSION` constant.
## Quick start
1. Install dependencies. You can find a current list of dependencies in the [Dockerfile](Dockerfile-debian).
* Ensure to install `protoc` from and place it in your `$PATH`, as we
**don't support protoc shipped with your distribution** (like Ubuntu).
2. Add tenderdash-abci crate to your project:
```bash
cargo add --git https://github.com/dashpay/rs-tenderdash-abci tenderdash-abci
```
3. Implement the [Application](abci/src/application.rs) trait with your custom logic. You can check [kvstore](abci/tests/kvstore.rs) as a minimal example.
## Using custom protocol buffers definitions
If you want to build `rs-tenderdash-abci` using protocol buffers definitions from a custom Tenderdash version, you can do so by setting the `TENDERDASH_COMMITISH` environment variable to the desired Tenderdash commit ID before initiating the build process.
For instance, if you want to build the library with support for Tenderdash `v0.14-dev.3`, which corresponds to the commit ID `688ee3e3f2624e6ebb20f5d74e0812109b7b9a27`, you can use the following command:
```bash
export TENDERDASH_COMMITISH=688ee3e3f2624e6ebb20f5d74e0812109b7b9a27
cargo build
```
## Credits
This project is a partial fork of [tendermint-rs] project.
## License
[MIT](LICENSE.md)
[Tenderdash]: https://github.com/dashpay/tenderdash
[tendermint-rs]: https://github.com/informalsystems/tendermint-rs