Skip to content

Commit

Permalink
sync
Browse files Browse the repository at this point in the history
  • Loading branch information
survived committed Feb 22, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 7abbb8c commit 6aabd80
Showing 4 changed files with 49 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/readme.yml
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
6 changes: 6 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -9,3 +9,9 @@ docs-open:
docs-private:
RUSTDOCFLAGS="--html-in-header katex-header.html --cfg docsrs" cargo +nightly doc --no-deps --all-features --document-private-items

readme:
cargo readme --no-title -r givre -i src/lib.rs \
| perl -ne 's/(?<!!)\[([^\[]+?)\]\([^\(]+?\)/\1/g; print;' \
| perl -ne 's/\[mod@([^\[]+?)\]/\1/g; print;' \
> README.md

18 changes: 18 additions & 0 deletions README.md
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
1 change: 1 addition & 0 deletions docs/readme-template
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{readme}}

0 comments on commit 6aabd80

Please sign in to comment.