absolutebi/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2025-12-08 12:19:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update READMEs, targeting an 80-character line limit

Browse Source
This commit is contained in:
Luke Parker
2025-08-18 01:55:37 -04:00
parent e87bbcda64
commit cfce2b26e2
5 changed files with 20 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
crypto/dkg/README.md
View File

@@ -1,11 +1,12 @@
# Distributed Key Generation
A crate implementing a type for keys, presumably the result of a distributed key generation
protocol, and utilities from there.
A crate implementing a type for keys, presumably the result of a distributed
key generation protocol, and utilities from there.
This crate used to host implementations of distributed key generation protocols as well (hence the
name). Those have been smashed into their own crates, such as
[`dkg-musig`](https://docs.rs/dkg-musig) and [`dkg-pedpop`](https://docs.rs/dkg-pedpop)
This crate used to host implementations of distributed key generation protocols
as well (hence the name). Those have been smashed into their own crates, such
as [`dkg-musig`](https://docs.rs/dkg-musig) and
[`dkg-pedpop`](https://docs.rs/dkg-pedpop).
Before being smashed, this crate was [audited by Cypher Stack in March 2023](
https://github.com/serai-dex/serai/raw/e1bb2c191b7123fd260d008e31656d090d559d21/audits/Cypher%20Stack%20crypto%20March%202023/Audit.pdf

6
crypto/dkg/musig/README.md
View File

@@ -1,9 +1,9 @@
# Distributed Key Generation - MuSig
This implements the MuSig key aggregation protocol for the [`dkg`](https://docs.rs/dkg) crate's
types.
This implements the MuSig key aggregation protocol for the
[`dkg`](https://docs.rs/dkg) crate's types.
This crate was originally part of the `dkg` crate, which was
This crate was originally part of (in some form) the `dkg` crate, which was
[audited by Cypher Stack in March 2023](
https://github.com/serai-dex/serai/raw/e1bb2c191b7123fd260d008e31656d090d559d21/audits/Cypher%20Stack%20crypto%20March%202023/Audit.pdf
), culminating in commit

4
crypto/dkg/pedpop/README.md
View File

@@ -1,7 +1,7 @@
# Distributed Key Generation - PedPoP
This implements the PedPoP distributed key generation protocol for the [`dkg`](https://docs.rs/dkg)
crate's types.
This implements the PedPoP distributed key generation protocol for the
[`dkg`](https://docs.rs/dkg) crate's types.
This crate was originally part of the `dkg` crate, which was
[audited by Cypher Stack in March 2023](

5
crypto/dkg/promote/README.md
View File

@@ -1,7 +1,8 @@
# Distributed Key Generation - Promote
This crate implements 'promotions' for keys from the [`dkg`](https://docs.rs/dkg) crate. A promotion
takes a set of keys and maps it to a different `Ciphersuite`.
This crate implements 'promotions' for keys from the
[`dkg`](https://docs.rs/dkg) crate. A promotion takes a set of keys and maps it
to a different `Ciphersuite`.
This crate was originally part of the `dkg` crate, which was
[audited by Cypher Stack in March 2023](

12
crypto/dkg/recovery/README.md
View File

@@ -1,11 +1,11 @@
# Distributed Key Generation
# Distributed Key Generation - Recovery
A crate implementing a type for keys, presumably the result of a distributed key generation
protocol, and utilities from there.
A utility function to recover a key from its secret shares.
This crate used to host implementations of distributed key generation protocols as well (hence the
name). Those have been smashed into their own crates, such as
[`dkg-musig`](https://docs.rs/dkg-musig) and [`dkg-pedpop`](https://docs.rs/dkg-pedpop)
Keys likely SHOULD NOT ever be recovered, making this primarily intended for
testing purposes. Instead, the shares of the key should be used to produce
shares for the desired action, allowing using the key while never
reconstructing it.
Before being smashed, this crate was [audited by Cypher Stack in March 2023](
https://github.com/serai-dex/serai/raw/e1bb2c191b7123fd260d008e31656d090d559d21/audits/Cypher%20Stack%20crypto%20March%202023/Audit.pdf