multiversx-bls for Rust

This is a wrapper library of bls, that bridges the functionality with MultiversX crypto packages.

Spec Name

multiversx-bls	Spec Name
G1	Signature
G2	Public Key

G1 - Signature

verify(&self, public_key: G2, msg: &[u8]) -> bool

• Checks if self is a valid signature of message for the given public key.

fast_aggregate_verify(&self, public_keys: &[G2], msg: &[u8]) -> bool

• Checks if self is a valid aggregated signature of message for multiple public keys.

add_assign(&mut self, signature: G1)

• Adds another signature to self (signature aggregation).

is_valid_order(&self) -> bool

• Checks if self is a valid signature of the correct group order.

aggregate(&mut self, sigs: &[G1])

• Sets self as the aggregated signature of signatures.

is_zero(&self) -> bool

• Checks if self is the point at infinity (zero element).

is_valid(&self) -> bool

• Checks if self is a valid G1 element.

verify_signature_order(verify: bool)

• Enables or disables signature order verification:
  • true: verification enabled;
  • false: verification disabled (default).

deserialize(&mut self, buf: &[u8]) -> bool

• Deserialize a signature from an array of bytes.

from_serialized(buf: &[u8]) -> Result<Self, BlsError>

• Creates a new G1 element from a serialized buffer:
  • G1 if successful;
  • Return BlsError::InvalidData on failure.

serialize(&self) -> Result<Vec<u8>, BlsError>

• Serializes the signature into a vector of bytes:
  • A vector of bytes if successful;
  • Return BlsError::SerializeError on failure.

G2 - Public Key

add_assign(&mut self, public_key: G2)

• Adds another public key to self.

is_valid_order(&self) -> bool

• Checks if self is a valid public key of the correct group order.

set_str(&mut self, s: &str)

• Sets the G2 element from a base-10 string.

deserialize_g2(&mut self, buf: &[u8]) -> bool

• Deserializes a G2 element from a byte buffer.

is_zero(&self) -> bool

• Checks if self is the point at infinity (zero element).

is_valid(&self) -> bool

• Checks if self is a valid G2 element.

verify_public_key_order(verify: bool)

• Enables/disables verification of public key order when setting keys:
  • true: verification enabled;
  • false: verification disabled (default).

serialize(&self) -> Result<Vec<u8>, BlsError>

• Serializes the public key into a byte array.
  • A vector of bytes if successful;
  • Return BlsError::SerializeError on failure.

deserialize(&mut self, buf: &[u8]) -> bool

• Deserializes a public key from a byte array.

from_serialized(buf: &[u8]) -> Result<Self, BlsError>

• Creates a new G2 element from a serialized buffer:
  • Returns G2 if successful;
  • Returns BlsError::InvalidData otherwise.

Secret Key

set_by_csprng(&mut self)

• Initializes the secret key using a cryptographically secure random number generator (CSPRNG). Panics if the generated key is zero.

set_hex_str(&mut self, s: &str) -> bool

• Sets the secret key from a hexadecimal string.

from_hex_str(s: &str) -> Result<SecretKey, BlsError>

• Creates a new secret key from a hexadecimal string:
  • Returns SecretKey if valid;
  • Returns BlsError::InvalidData if invalid.

get_public_key(&self) -> G2

• Derives the public key (G2) corresponding to this secret key.

sign(&self, msg: &[u8]) -> G1

• Generates a signature (G1) of the given message.

deserialize(&mut self, buf: &[u8]) -> bool

• Deserializes a secret key from a byte array. Returns true if successful and length matches.

from_serialized(buf: &[u8]) -> Result<Self, BlsError>

• Creates a new secret key from serialized data:
  • Returns SecretKey if valid;
  • Returns BlsError::InvalidData if invalid.

serialize(&self) -> Result<Vec<u8>, BlsError>

• Serializes the secret key into a byte array:
  • A vector of bytes if successful;
  • Return BlsError::SerializeError on failure.

Executors

• Executors are extracted from bls-go-binary, version v1.28.2.

Usage

Example: creating a public key from a vector of bytes.

let buffer = [0; 96];

let mut public_key = G2::default();

if !public_key.deserialize_g2(&buffer) {
    return Err(BlsError::InvalidData);
}

Example: creating a signature from a vector of bytes.

let buffer = [0; 48];

let mut sign = G1::default();

if !sign.deserialize(&buffer) {
    return Err(BlsError::InvalidData);
}

Example: verifying a BLS signature with a single public key and message.

fn verify_signature(signature: G1, public_key: G2, message: &[u8]) {
    signature.verify(public_key, message)
}

Acknowledgements

This repository originated as a fork of herumi/bls-eth-rust by MITSUNARI Shigeo, a Rust wrapper around the herumi/bls C library. The original implementation provided the foundational FFI bindings and BLS primitives that this library builds upon.

The codebase has since been substantially rewritten — Ethereum-specific logic was removed, the API was restructured into dedicated modules, and the library was tailored to MultiversX's requirements. The fork has been detached from the upstream repository to reflect this divergence.