hbbft/README.md

23 lines
812 B
Markdown
Raw Normal View History

2018-05-04 09:18:57 -07:00
[![Build Status](https://travis-ci.com/poanetwork/hbbft.svg?branch=master)](https://travis-ci.com/poanetwork/hbbft)
[![Gitter](https://badges.gitter.im/poanetwork/hbbft.svg)](https://gitter.im/poanetwork/hbbft?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
2018-05-04 09:11:49 -07:00
# About
An implementation of the paper
["Honey Badger of BFT Protocols"](https://eprint.iacr.org/2016/199.pdf)
in Rust. This is a modular library of consensus. There are
[examples](./examples/README.md) illustrating the use of this algorithm.
2018-05-17 02:51:14 -07:00
**This is work in progress.** Parts of the algorithm are still missing
or incomplete.
An example is included to run a simulation of a network:
$ cargo run --example simulation --features=serialization-serde -- -h
2018-05-17 02:51:14 -07:00
2018-05-04 09:11:49 -07:00
# Building
You can build `hbbft` using cargo:
2018-05-04 09:11:49 -07:00
$ cargo build [--release]