twenty-first

A collection of cryptography primitives written in Rust.

Content of this library

This library contains primarily the following cryptographic primitives:

• The Tip5 hash function
  • The Tip5 Hash Function for Recursive STARKs
• Lattice-crypto
  • arithmetic for the quotient ring $\mathbb{F}_ p[X] / \langle X^{64} + 1 \rangle$
  • arithmetic for modules over this quotient ring
  • a IND-CCA2-secure key encapsulation mechanism
  • Lattice-Based Cryptography in Miden VM
• BFieldElement, XFieldElement
  • The prime-field type $\mathbb{F}_p$ where $p = 2^{64} - 2^{32} + 1$
  • The extension field $\mathbb{F}_p[x]/(x^3 - x + 1)$
  • A codec trait for encoding and decoding structs as Vecs of BFieldElement
  • An efficient prime for number-theoretic transforms
• NTT
  • Number Theoretic Transform (discrete Fast Fourier Transform)
  • Anatomy of a STARK, Part 6: Speeding Things Up
• Univariate and multivariate polynomials
• Merkle Trees
• Merkle Mountain Ranges

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

This crate depends on the rs-leveldb crate which wraps the C++ implementation of leveldb. As such, snappy and leveldb must be installed. Eg, on Ubuntu:

sudo apt-get install libleveldb-dev libsnappy-dev

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