54537baf34 | ||
---|---|---|
.. | ||
src | ||
tests | ||
Cargo.toml | ||
README.md | ||
tests.rs |
README.md
FROST Participant Demo
Status ⚠
The Participant 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 participant
Round 1
The participant CLI will prompt for:
- Your secret share or key package
The participant CLI will then use that data to generate:
- Signing nonces
- Signing commitments
Communication round
The signing commitments will be sent to the coordinator The coordinator will then send the signing package
Round 2
The participant CLI will prompt for:
- Signing package
The participant CLI will then use that data to generate:
- Signature share
Communication round
The signature share will be sent to the coordinator The coordinator will then send the Group signature
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
)