https://github.com/liamzebedee/tendermint-rs
A minimal reimplementation of Tendermint in Rust
https://github.com/liamzebedee/tendermint-rs
Last synced: 4 months ago
JSON representation
A minimal reimplementation of Tendermint in Rust
- Host: GitHub
- URL: https://github.com/liamzebedee/tendermint-rs
- Owner: liamzebedee
- Created: 2024-09-15T23:40:30.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-09-19T07:48:58.000Z (7 months ago)
- Last Synced: 2024-09-23T13:04:04.588Z (7 months ago)
- Language: Rust
- Size: 66.4 KB
- Stars: 22
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-ccamel - liamzebedee/tendermint-rs - A minimal reimplementation of Tendermint in Rust (Rust)
README
# tendermint-rs
A minimal reimplementation of the Tendermint BFT consensus protocol in Rust.
Dependencies:
* tokio - for async runtime.
* secp256k1 - for cryptographic identities.
* serde - for message serialisation.
* warp/reqwest - for HTTP server/clients (for node RPC).
* hex.
## Conceptual overview.
A consensus protocol consists of a set of processes, which communicate by sending messages to each other in order to agree on a value. Processes may crash, run at arbitrary speeds, and display byzantine failures. The challenge of consensus is building a protocol which can finalise and does so safely and consistently given these assumptions.
The basic Tendermint algorithm is implemented as `Process`. Each `Process` communicates via abstract channels - there is an implementation using just local communication (`examples/standalone-channels`), and an implementation using RPC over HTTP servers (`examples/standalone-http`). Processes emit consensus events via tokio async streams - consumers can subscribe to the process and receive callbacks for new values agreed on by the network (called "decisions"). Each node has an ECDSA keypair it uses to sign messages.
## Status.
Protocol runs and achieves consensus, with rounds, epochs.
See [PLAN](./PLAN.md) for the backlog.
## Usage.
### Running tests.
```sh
cargo build
cargo run --example standalone-channels
cargo run --example standalone-http
```
### Using it.
Rust Tendermint can be used to build a consistent and partition-tolerant network, with a custom value that is agreed per epoch, and event streams which allow you to consume different events (such agreement - referred to as a decision, and intermediate stages).
```rs
use tendermint::Process;
fn example() {
// Setup networking substrate between nodes.
let node = Process::new();
// Pass a get_value callback to get the next candidate value for proposal.
// Subscribe and listen to Decision events to process them.
}
```
See `examples/`.
## Readings.
- [The latest gossip on BFT consensus.](https://arxiv.org/abs/1807.04938)
- [Tendermint: Byzantine Fault Tolerance in the Age of Blockchains.](https://atrium.lib.uoguelph.ca/server/api/core/bitstreams/0816af2c-5fd4-4d99-86d6-ced4eef2fb52/content)