From cfce2b26e23f5143f3d0088f85e80d0d6bbea01c Mon Sep 17 00:00:00 2001 From: Luke Parker Date: Mon, 18 Aug 2025 01:55:37 -0400 Subject: [PATCH] Update READMEs, targeting an 80-character line limit --- crypto/dkg/README.md | 11 ++++++----- crypto/dkg/musig/README.md | 6 +++--- crypto/dkg/pedpop/README.md | 4 ++-- crypto/dkg/promote/README.md | 5 +++-- crypto/dkg/recovery/README.md | 12 ++++++------ 5 files changed, 20 insertions(+), 18 deletions(-) diff --git a/crypto/dkg/README.md b/crypto/dkg/README.md index eaad6ed5..90a70097 100644 --- a/crypto/dkg/README.md +++ b/crypto/dkg/README.md @@ -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 diff --git a/crypto/dkg/musig/README.md b/crypto/dkg/musig/README.md index 9720e6f0..b36d03ae 100644 --- a/crypto/dkg/musig/README.md +++ b/crypto/dkg/musig/README.md @@ -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 diff --git a/crypto/dkg/pedpop/README.md b/crypto/dkg/pedpop/README.md index 4ff801e0..4b72cfe0 100644 --- a/crypto/dkg/pedpop/README.md +++ b/crypto/dkg/pedpop/README.md @@ -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]( diff --git a/crypto/dkg/promote/README.md b/crypto/dkg/promote/README.md index a5f8a9e6..8a726aac 100644 --- a/crypto/dkg/promote/README.md +++ b/crypto/dkg/promote/README.md @@ -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]( diff --git a/crypto/dkg/recovery/README.md b/crypto/dkg/recovery/README.md index eaad6ed5..f9e83ac5 100644 --- a/crypto/dkg/recovery/README.md +++ b/crypto/dkg/recovery/README.md @@ -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