Adding `blastkids` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add blastkids

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

blastkids = "0.2.0"

The blastkids library will be automatically available globally. Read the blastkids library documentation.

Back to the crate overview.

Readme

Blastkids 🚀🔑🔑🔑

A BLS12-381 child key derivation library written in Rust. Implements EIP-2333 and EIP-2334.

Fork of rust-bls-derivation using bls12_381_plus instead of curv-kzen, plus cleanup and documentation.

Rationale

If you want to use Delegatable Anonymous Credentials the verification key (VK) becomes as long as the credential entries. Since a VK is simply several BLS12-381 public keys (PKs) we can use a derivation algorithm such as EIP-2333 in order to derive the long VK from a single root PK given any length.

Installation

cargo install blastkids

API & Docs

See documentation on docs.rs.

See tests in lib.rs for example usage.

use blastkids::{Manager, Zeroizing, derive};
use blastkids::{G1, G2};

// make a new manager for a G2 public key
let seed = Zeroizing::new([42u8; 32]);
let manager: Manager<G2> = Manager::from_seed(seed);

// With a Manager you can create as many account sas you need
let account_number = 1u32;
let account = manager.account(account_number);

let length = 8u8; // Specify how many Child Public Keys you need (in this case, 8). Can be up to 255.

// Anyone can use an Account Public Key and a `length` to derive an expanded account
let expanded_pk: Vec<G2> = derive(&account.pk, length);

// When you want to use the child account secret keys,
// you call `expand_to` on the account
let expanded = account.expand_to(length);

// This expand public keys are the same as the ones derived above
assert_eq!(expanded.pk, expanded_pk);

Tests

cargo test

Dependencies

BLS12-381: bls12_381_plus
Elliptic Curve: RustCrypto/elliptic-curves
Big Integers: RustCrypto/ctypro-bigint

Prior Work

EIP-2333
EIP-2334
rust-bls-derivation (circa 2023, uses curv-kzen library which breaks with rust-nightly and appears somewhat unmaintained)

Contributing

Contributions are welcome! Please open an issue if you have any feature ideas or find any bugs. I also accept pull requests with open arms. Please:

Fork this repo
Create a new branch for your changes
Open a draft pull request so we can follow and collaborate on your changes
Add tests for your changes
Keep the diff minimal for each pull request
Write meaningful commit messages
Change Draft to Open when you're ready for final review

Adding blastkids library as a dependency

Adding `blastkids` library as a dependency