frost-zcash-demo/participant
dependabot[bot] 9fd22c93e5
build(deps): bump clap from 4.5.21 to 4.5.23 (#396)
Bumps [clap](https://github.com/clap-rs/clap) from 4.5.21 to 4.5.23.
- [Release notes](https://github.com/clap-rs/clap/releases)
- [Changelog](https://github.com/clap-rs/clap/blob/master/CHANGELOG.md)
- [Commits](https://github.com/clap-rs/clap/compare/clap_complete-v4.5.21...clap_complete-v4.5.23)

---
updated-dependencies:
- dependency-name: clap
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-12-09 14:22:28 -03:00
..
src frost-client: add encryption and authentication (#336) 2024-11-20 15:11:47 +00:00
tests participant: use generics 2024-07-01 14:29:14 +01:00
Cargo.toml build(deps): bump clap from 4.5.21 to 4.5.23 (#396) 2024-12-09 14:22:28 -03:00
README.md Update READMEs (#54) (#71) 2023-08-21 19:01:16 -03:00
tests.rs Add Participant project (#15) 2023-06-15 13:23:37 -03:00

README.md

FROST Participant Demo

Overview of demos

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:

  1. Clone the repo. Run git clone https://github.com/ZcashFoundation/frost-zcash-demo.git
  2. Run cargo install
  3. Run cargo run --bin participant

Round 1

The participant CLI will prompt for:

  1. Your secret share or key package

The participant CLI will then use that data to generate:

  1. Signing nonces
  2. 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:

  1. Signing package

The participant CLI will then use that data to generate:

  1. 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

  1. 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:

  1. Install coverage tool by running cargo install cargo-llvm-cov
  2. Run cargo make cov (you may be asked if you want to install llvm-tools-preview, if so type Y)