-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
49 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
name: Check README | ||
|
||
on: | ||
pull_request: | ||
branches: [ "*" ] | ||
|
||
env: | ||
CARGO_TERM_COLOR: always | ||
CARGO_NET_GIT_FETCH_WITH_CLI: true | ||
|
||
jobs: | ||
check_readme: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Install cargo-hakari | ||
uses: baptiste0928/cargo-install@v1 | ||
with: | ||
crate: cargo-readme | ||
- name: Check that readme matches lib.rs | ||
run: | | ||
cp README.md README-copy.md | ||
make readme | ||
diff README.md README-copy.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,19 @@ | ||
Threshold Schnorr implementation based on [FROST IETF Draft][draft] | ||
|
||
FROST is state of art protocol for Threshold Schnorr Signatures that supports 1-round signing (requires signers to | ||
commit nonces ahead of time), and identifiable abort. | ||
|
||
This crate provides: | ||
* Threshold and non-threshold Distributed Key Generation (DKG) \ | ||
Note that FROST does not define DKG protocol to be used. We simply re-export DKG based on [CGGMP21] implementation | ||
when `cggmp21-keygen` feature is enabled. Alternatively, you can use any other UC-secure DKG protocol. | ||
* FROST Signing \ | ||
We provide API for both manual signing execution (for better flexibility and efficiency) and interactive protocol | ||
(for easier usability and fool-proof design), see signing module for details. | ||
* Trusted dealer (importing key into TSS) | ||
|
||
This crate doesn't support (currently): | ||
* Identifiable abort | ||
|
||
[CGGMP21]: https://github.com/dfns/cggmp21 | ||
[draft]: https://www.ietf.org/archive/id/draft-irtf-cfrg-frost-15.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{{readme}} |