logos-co
/
consensus-research
mirror of https://github.com/logos-co/consensus-research.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Collection of consensus algorithm implementation for research and simulations
4 Commits 1 Branch 0 Tags 76 KiB
Rust 100%
Go to file
Daniel Sanchez Quiros 101cf169e4 Added licenses 2022-10-20 12:09:30 +02:00
.github/workflows Add gh workflow 2022-10-19 16:28:29 +02:00
consensus Added licenses 2022-10-20 12:09:30 +02:00
resources/snow-family Missing simulation updates 2022-10-19 15:56:58 +02:00
simulations/snow-family Missing simulation updates 2022-10-19 15:56:58 +02:00
.gitignore Extract claro simulations into new repository 2022-10-19 15:17:22 +02:00
Cargo.lock Missing simulation updates 2022-10-19 15:56:58 +02:00
Cargo.toml Extract claro simulations into new repository 2022-10-19 15:17:22 +02:00
LICENSE-APACHEv2 Added licenses 2022-10-20 12:09:30 +02:00
LICENSE-MIT Added licenses 2022-10-20 12:09:30 +02:00
README.md Missing simulation updates 2022-10-19 15:56:58 +02:00

README.md

Consensus Research

Project Structure

  • consensus: Consensus implementation libraries
    • snowball: Snowball implementation
    • claro: Claro implementation
  • prototypes: Simulations and experiments related libraries and binaries
    • snow-family: Snow family and claro simulations app

Build & Test

Minimal Rust supported version: 1.63

When in development, please, use cargo clippy to build the project. Any warning is promoted to an error in our CI.

  • Use cargo test for executing tests, and cargo test -- --nocapture for seeing test outputs.
  • Use cargo run --exampel {example_name} to run an example.

Build Documentation

Simply run cargo doc --open --no-deps to build and access a copy of the generated documentation.