3de12e402b
Bump lodash from 4.17.19 to 4.17.21 |
||
---|---|---|
.github | ||
benchmark | ||
src | ||
test | ||
.eslintrc.js | ||
.gitignore | ||
.mocharc.yml | ||
.prettierignore | ||
.prettierrc.yml | ||
CHANGELOG.md | ||
LICENSE | ||
README.md | ||
blst-native.d.ts | ||
blst-native.js | ||
browser.d.ts | ||
browser.js | ||
herumi.d.ts | ||
herumi.js | ||
karma.conf.js | ||
node.d.ts | ||
node.js | ||
package.json | ||
tsconfig.build.json | ||
tsconfig.json | ||
webpack.config.js | ||
yarn.lock |
README.md
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 (node.js-only, bindings to C via node-gyp)herumi
: src/herumi (node.js & browser, wasm)noble
: noble-bls12-381 (node.js & browser, pure JS)
Results are in ops/sec (x times slower)
, where x times slower
= times slower than fastest implementation (blst
).
Function - ops/sec |
blst |
herumi |
noble |
---|---|---|---|
verify |
326.38 | 47.674 (x7) | 17.906 (x18) |
verifyAggregate (30) |
453.29 | 51.151 (x9) | 18.372 (x25) |
verifyMultiple (30) |
34.497 | 3.5233 (x10) | 2.0286 (x17) |
verifyMultipleSignatures (30) |
26.381 | 3.1633 (x8) | - |
aggregate (pubkeys, 30) |
15686 | 2898.9 (x5) | 1875.0 (x8) |
aggregate (sigs, 30) |
6373.4 | 1033.0 (x6) | 526.25 (x12) |
sign |
925.49 | 108.81 (x9) | 10.246 (x90) |
* blst
and herumi
performed 100 runs each, noble
10 runs.
Results from CI run https://github.com/ChainSafe/bls/runs/1513710175?check_suite_focus=true#step:12:13
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 |
License
Apache-2.0