24 releases

0.10.0 Feb 19, 2024
0.9.1 Jul 12, 2023
0.8.2 Dec 16, 2022
0.7.1 May 6, 2022
0.1.1 Jul 29, 2020

#20 in #schnorr

Download history 2823/week @ 2024-07-14 2821/week @ 2024-07-21 2641/week @ 2024-07-28 3529/week @ 2024-08-04 2851/week @ 2024-08-11 3456/week @ 2024-08-18 2727/week @ 2024-08-25 2911/week @ 2024-09-01 2535/week @ 2024-09-08 2256/week @ 2024-09-15 2569/week @ 2024-09-22 2867/week @ 2024-09-29 2635/week @ 2024-10-06 1369/week @ 2024-10-13 40/week @ 2024-10-20 16/week @ 2024-10-27

4,153 downloads per month

0BSD license

465KB
8K SLoC

SchnorrFun! crates_badge docs_badge

Generate and verify Schnorr signatures on secp256k1. Built on secp256kfun.

Schnorr signatures were introduced (and patented until 2008) by their namesake in Efficient Signature Generation by Smart Cards. This implementation is based on the BIP-340 specification, but is flexible enough to be used as a general purpose Schnorr signature scheme.

Use

[dependencies]
schnorr_fun = "0.10"
sha2 = "0.10"

Should use?

This library and secp256kfun are experimental.

Synopsis

use schnorr_fun::{
    fun::{marker::*, Scalar, nonce},
    Schnorr,
    Message
};
use sha2::Sha256;
use rand::rngs::ThreadRng;
// Use synthetic nonces
let nonce_gen = nonce::Synthetic::<Sha256, nonce::GlobalRng<ThreadRng>>::default();
let schnorr = Schnorr::<Sha256, _>::new(nonce_gen.clone());
// Generate your public/private key-pair
let keypair = schnorr.new_keypair(Scalar::random(&mut rand::thread_rng()));
// Sign a variable length message
let message = Message::<Public>::plain("the-times-of-london", b"Chancellor on brink of second bailout for banks");
// Sign the message with our keypair
let signature = schnorr.sign(&keypair, message);
// Get the verifier's key
let verification_key = keypair.public_key();
// Check it's valid 🍿
assert!(schnorr.verify(&verification_key, message, &signature));

Features

  • BIP-340 compliant signing and verification
  • Adaptor signatures
  • compatibility with rust-secp256k1's schnorr signature types with libsecp_compat feature.
  • MuSig2 implementation compatible with the spec.
  • WIP FROST implementation
  • Feature flags
    • serde: for serde implementations for signatures
    • bincode: for bincode v2 Encode/Decode implementations
    • libsecp_compat: for From implementations between rust-secp256k1's Schnorr signatures.
    • proptest to enable secp256kfun/proptest.
    • share_backup to enable bech32 backups of FROST secret shares

Dependencies

~0.4–2MB
~31K SLoC