bls

Javascript library for BLS (Boneh-Lynn-Shacham) signatures and signature aggregation, tailored for use in Eth2.

Usage

yarn add @chainsafe/bls

To use native bindings you must install peer dependency @chainsafe/blst

yarn add @chainsafe/bls @chainsafe/blst

You must initialize the library once in your application before using it. The result is cached and use across all your imports

import {init, SecretKey, secretKeyToPublicKey, sign, verify} from "@chainsafe/bls";

(async () => {
  await init("herumi");

  // class-based interface
  const secretKey = SecretKey.fromKeygen();
  const publicKey = secretKey.toPublicKey();
  const message = new Uint8Array(32);

  const signature = secretKey.sign(message);
  console.log("Is valid: ", signature.verify(publicKey, message));

  // functional interface
  const sk = secretKey.toBytes();
  const pk = secretKeyToPublicKey(sk);
  const sig = sign(sk, message);
  console.log("Is valid: ", verify(pk, message, sig));
})();

Browser

If you are in the browser, import from /browser to import directly the WASM version

import bls from "@chainsafe/bls/browser";

Native bindings only

If you are in NodeJS, import from /node to skip browser specific code. Also install peer dependency @chainsafe/blst which has the native bindings

yarn add @chainsafe/bls @chainsafe/blst

import bls from "@chainsafe/bls/node";

Native bindings + WASM fallback

If you want to offer a fallback in NodeJS, first try to load native bindings and then fallback to WASM. Also install peer dependency @chainsafe/blst which has the native bindings

yarn add @chainsafe/bls @chainsafe/blst

import {init} from "@chainsafe/bls";

try {
  await init("blst-native");
} catch (e) {
  await init("herumi");
  console.warn("Using WASM");
}

The API is identical for all implementations.

Benchmarks

• blst: src/blst
• herumi: src/herumi
• noble: noble-bls12-381

blst verify:      502.72 ops/sec (100 runs)
blst verifyAgg:   489.60 ops/sec (100 runs)
blst aggPubkey:   8326.6 ops/sec (100 runs)
blst aggSigs:     6968.3 ops/sec (100 runs)
herumi verify:    53.792 ops/sec (100 runs)
herumi verifyAgg: 52.897 ops/sec (100 runs)
herumi aggPubkey: 3020.1 ops/sec (100 runs)
herumi aggSigs:   1151.2 ops/sec (100 runs)
noble verify:     13.868 ops/sec (10 runs)
noble verifyAgg:  11.241 ops/sec (10 runs)
noble aggPubkey:  47.309 ops/sec (10 runs)

Results from CI run https://github.com/ChainSafe/bls/runs/1478915060

Spec versioning

Version	Bls spec hash-to-curve version
5.x.x	draft #9
2.x.x	draft #7
1.x.x	draft #6
0.3.x	initial version

spec

test vectors

License

Apache-2.0