96 lines
2.5 KiB
Markdown
96 lines
2.5 KiB
Markdown
# bls
|
|
|
|
[](https://travis-ci.org/ChainSafe/lodestar)
|
|
[](https://codecov.io/gh/ChainSafe/lodestar)
|
|
|
|
|
|
|
|
|
|
Javascript library for BLS (Boneh-Lynn-Shacham) signatures and signature aggregation.
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
yarn add @chainsafe/bls
|
|
```
|
|
|
|
To use native bindings you must install peer dependency `@chainsafe/blst`
|
|
|
|
```bash
|
|
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
|
|
|
|
```ts
|
|
import bls, {init} from "@chainsafe/bls";
|
|
|
|
(async () => {
|
|
await init("herumi");
|
|
|
|
const secretKey = bls.PrivateKey.fromKeygen();
|
|
const publicKey = secretKey.toPublicKey();
|
|
const message = new Uint8Array(32);
|
|
|
|
const signature = secretKey.sign(message);
|
|
console.log("Is valid: ", signature.verify(publicKey, message));
|
|
})();
|
|
```
|
|
|
|
### Browser
|
|
|
|
If you are in the browser, import from `/browser` to import directly the WASM version
|
|
|
|
```ts
|
|
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
|
|
|
|
```bash
|
|
yarn add @chainsafe/bls @chainsafe/blst
|
|
```
|
|
|
|
```ts
|
|
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
|
|
|
|
```bash
|
|
yarn add @chainsafe/bls @chainsafe/blst
|
|
```
|
|
|
|
```ts
|
|
import bls from "@chainsafe/bls";
|
|
|
|
try {
|
|
await bls.init("blst-native");
|
|
} catch (e) {
|
|
await bls.init("herumi");
|
|
console.warn("Using WASM");
|
|
}
|
|
```
|
|
|
|
The API is identical for all implementations.
|
|
|
|
## Spec versioning
|
|
|
|
| Version | Bls spec version |
|
|
| ------- | :--------------: |
|
|
| 2.x.x | draft #7 |
|
|
| 1.x.x | draft #6 |
|
|
| 0.3.x | initial version |
|
|
|
|
> [spec](https://github.com/ethereum/eth2.0-specs/blob/v0.11.1/specs/phase0/beacon-chain.md#bls-signatures)
|
|
|
|
> [test vectors](https://github.com/ethereum/eth2.0-spec-tests/tree/master/tests/bls)
|
|
|
|
## License
|
|
|
|
Apache-2.0
|