54537baf34 | ||
---|---|---|
.. | ||
src | ||
Cargo.toml | ||
README.md | ||
tests.rs |
README.md
FROST Coordinator Demo
Status ⚠
The Coordinator Demo is a WIP
Usage
NOTE: This is for demo purposes only and should not be used in production.
You will need to have Rust and Cargo installed.
To run:
- Clone the repo. Run
git clone https://github.com/ZcashFoundation/frost-zcash-demo.git
- Run
cargo install
- Run
cargo run --bin coordinator
Step 1
The coordinator CLI will prompt for:
- The public key package
- The number of signers participating and their corresponding identifiers
Communication round
Each participant will send their commitments
Step 2
The coordinator CLI will prompt for:
- A message
- The commitments for each participant
The coordinator CLI will then use that data to generate:
- Signing package
Communication round
The signing package will be sent to all participants The coordinator will receive each participant's signature shares
Step 3
The coordinator CLI will prompt for:
- Signature shares for ecah participant
The coordinator CLI will then use that data to generate:
- The group signature
Communication round
The group signature will then be sent to all participants
Developer information
Pre-commit checks
- Run
cargo make all
Coverage
Test coverage checks are performed in the pipeline. This is configured here: .github/workflows/coverage.yaml
To run these locally:
- Install coverage tool by running
cargo install cargo-llvm-cov
- Run
cargo make cov
(you may be asked if you want to installllvm-tools-preview
, if so typeY
)