Skip to content

Collection of mathematics routines and cryptography for the twenty-first century

License

Notifications You must be signed in to change notification settings

Neptune-Crypto/twenty-first

Repository files navigation

twenty-first

GitHub CI crates.io Coverage Status

A collection of cryptography primitives written in Rust.

Content of this library

This library contains primarily the following cryptographic primitives:

Release protocol

While twenty-first's version is 0.x.y, releasing a new version:

  1. Is the release backwards-compatible? Then the new version is 0.x.y+1. Otherwise the new version is 0.x+1.0.
  2. Checkout the last commit on Mjolnir, and run make bench-publish. Save the benchmark's result and verify that there is no performance degredation.
  3. Create a commit that increases version = "0.x.y" in twenty-first/Cargo.toml. The commit message should give a one-line summary of each release change. Include the benchmark result at the bottom.
  4. Have a v0.x.y git tag on this commit created. (git tag v0.x.y [sha], git push upstream --tags)
  5. Have this commit cargo published on crates.io and in GitHub tags.

If you do not have the privilege to create git tags or run cargo publish, submit a PR and the merger will take care of these.

Building

For detailed buildings instructions, see the description in HACKING.md.