Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update release checklist; misc cleanups #843

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions book/src/dev/release-checklist.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Release Checklist

## One-time `gh` setup

Install the [GitHub command line
tool](https://github.com/cli/cli?tab=readme-ov-file#installation) to make
releases easier.

## One-time crates.io setup

Expand Down Expand Up @@ -70,9 +75,10 @@

18. Check if frost-rerandomized is ready to be published: `cargo publish -p frost-rerandomized --dry-run`. Fix any errors if needed.

19. Draft and publish a frost-rerandomized release
19. Draft and publish a frost-rerandomized release:

1. Use the same process as described for frost-core above, but you can leave the changelog empty and **uncheck** “Set as the latest release”
1. Run `gh release create "frost-rerandomized/v2.1.0" -n '' -t "frost-rerandomized v2.1.0" --latest=false`
(replace both instances of the version)

20. Publish it with `cargo publish -p frost-rerandomized`

Expand All @@ -84,9 +90,9 @@

This is because the ciphersuite crates aren’t pointing at the new frost-core package. This is because you need to publish frost-core before you can publish the others otherwise they will not have the expected version to point to.

22. Draft and publish releases for each of those crates (sorry, that will be boring)
22. Draft and publish releases for each of those crates:

1. Use the same process as described for frost-core above (actions 1 - 3), but you can leave the changelog empty and **uncheck** “Set as the latest release”
1. Run `for cs in ristretto255 ed25519 secp256k1 secp256k1-tr p256 ed448; do gh release create "frost-$cs/v2.1.0" -n '' -t "frost-$cs v2.1.0" --latest=false; done` (replace both instances of the version)

23. Publish those crates: `for cs in ristretto255 ed25519 secp256k1 secp256k1-tr p256 ed448; do cargo publish -p frost-$cs; done`

Expand Down
4 changes: 2 additions & 2 deletions frost-core/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Entries are listed in reverse chronological order.

* It is now possible to identify the culprit in `frost_core::keys::dkg::part3()`
if an invalid secret share was sent by one of the participants (by calling
frost_core::Error<C>::culprit()`) (#728)
`frost_core::Error<C>::culprit()`) (#728)
* Added frost-secp256k1-tr crate, allowing to generate Bitcoin Taproot
(BIP340/BIP341) compatible signatures(#730).
(BIP340/BIP341) compatible signatures (#730).
* Support refreshing shares using the DKG approach using the
`frost_core::keys::refresh::refresh_dkg_{part1,part2,shares}()` functions
(#766).
Expand Down
6 changes: 3 additions & 3 deletions frost-core/src/keys/refresh.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
//! Refresh Shares
//!
//! Implements the functionality to refresh a share. This requires the participation
//! of all the remaining signers. This can be done using a Trusted Dealer or
//! DKG (not yet implemented)
//! Implements the functionality to refresh a share. This requires the
//! participation of all the remaining signers. This can be done using a Trusted
//! Dealer or DKG.

use alloc::collections::BTreeMap;
use alloc::vec::Vec;
Expand Down
Loading