Skip to content

Commit

Permalink
remove frost module (#568)
Browse files Browse the repository at this point in the history
  • Loading branch information
conradoplg authored Oct 31, 2023
1 parent 71c0925 commit a0df08e
Show file tree
Hide file tree
Showing 26 changed files with 550 additions and 568 deletions.
5 changes: 4 additions & 1 deletion frost-core/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ Entries are listed in reverse chronological order.

## Unreleased

## 0.8.0
## 1.0.0-rc.0

* The `frost-core::frost` module contents were merged into `frost-core`, thus
eliminating the `frost` module. You can adapt any calling code with e.g.
changing `use frost_core::frost::*` to `use frost-core::*`.
* Both serde serialization and the default byte-oriented serialization now
include a version field (a u8) at the beginning which is always 0 for now. The
ciphersuite ID field was moved from the last field to the second field, after
Expand Down
14 changes: 11 additions & 3 deletions frost-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,20 @@

Base traits and types in Rust that implement ['Two-Round Threshold Schnorr Signatures with
FROST'](https://datatracker.ietf.org/doc/draft-irtf-cfrg-frost/) generically for
`frost-core::Ciphersuite` implementations.
[`Ciphersuite`] implementations.

For key generation, refer to the [`keys`] module. For round-specific
types and functions, refer to the [`round1`] and [`round2`] modules. This module
contains types and functions not directly related to key generation and the
FROST rounds.


## Status ⚠

The FROST specification is not yet finalized, and this codebase has not yet been audited or
released. The APIs and types in `frost-core` are subject to change.
The FROST specification is not yet finalized, though no significant changes are
expected at this point. This code base has been audited by NCC. The APIs and
types in `frost-core` are subject to change during the release candidate phase,
and will follow SemVer guarantees after 1.0.0.

## Usage

Expand Down
3 changes: 2 additions & 1 deletion frost-core/src/benches.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ use std::collections::BTreeMap;
use criterion::{BenchmarkId, Criterion, Throughput};
use rand_core::{CryptoRng, RngCore};

use crate::{batch, frost, Ciphersuite, Signature, SigningKey, VerifyingKey};
use crate as frost;
use crate::{batch, Ciphersuite, Signature, SigningKey, VerifyingKey};

struct Item<C: Ciphersuite> {
vk: VerifyingKey<C>,
Expand Down
2 changes: 1 addition & 1 deletion frost-core/src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
use thiserror::Error;

use crate::{frost::Identifier, Ciphersuite};
use crate::{Ciphersuite, Identifier};

#[derive(Error, Debug, Clone, Copy, Eq, PartialEq)]
pub struct ParticipantError<C: Ciphersuite>(Identifier<C>);
Expand Down
Loading

0 comments on commit a0df08e

Please sign in to comment.