https://github.com/chainsafe/blst-ts
Typescript wrapper for https://github.com/supranational/blst native bindings, a highly performant BLS12-381 signature library
https://github.com/chainsafe/blst-ts
Last synced: 4 months ago
JSON representation
Typescript wrapper for https://github.com/supranational/blst native bindings, a highly performant BLS12-381 signature library
- Host: GitHub
- URL: https://github.com/chainsafe/blst-ts
- Owner: ChainSafe
- License: other
- Created: 2020-10-07T20:42:38.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-07-23T13:35:43.000Z (6 months ago)
- Last Synced: 2025-10-13T00:17:03.548Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 16.9 MB
- Stars: 19
- Watchers: 7
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# blst-ts
Typescript wrapper for [supranational/blst](https://github.com/supranational/blst) native bindings, a highly performant BLS12-381 signature library.
## Supported Environments
| OS / Arch | binary name | Node |
| ------------- | ----------- | ---------------------------------- |
| Linux / x64 | linux-x64 | 16, 18, 20, 21 |
| Linux / arm64 | linux-arm64 | 16, 18, 20, 21 |
| Windows / x64 | win32-x64 | 16, 18, 20, 21 |
| macOS / x64 | darwin-x64 | 16, 18, 20, 21 |
| macOS / arm64 | darwin-arm64 | 16, 18, 20, 21 |
## Usage
```bash
yarn add @chainsafe/blst
```
This library comes with pre-compiled bindings for most platforms. You can check current support in [releases](https://github.com/ChainSafe/blst-ts/releases). If your platform is not supported, bindings will be compiled from source as a best effort with node-gyp.
```ts
import crypto from "crypto";
import {SecretKey, verify, BLST_CONSTANTS} from "@chainsafe/blst";
const msg = Buffer.from("sample-msg");
const sk = SecretKey.fromKeygen(crypto.randomBytes(BLST_CONSTANTS.SECRET_KEY_LENGTH));
const pk = sk.toPublicKey();
const sig = sk.sign(msg);
console.log(verify(msg, pk, sig)); // true
```
This library exposes a classes for secret keys, public keys and signatures: `SecretKey`, `PublicKey` & `Signature`
The `PublicKey` and `Signature` contain an affine point (x,y) encoding of P1 in G1 and P2 in G2 respectively.
## Spec versioning
This library has a hardcoded configuration compatible with Eth2.0 spec:
| Setting | value |
| -------------- | --------------------------------------------- |
| PK_IN | `G1` |
| HASH_OR_ENCODE | `true` |
| DST | `BLS_SIG_BLS12381G2_XMD:SHA-256_SSWU_RO_POP_` |
| RAND_BITS | `64` |
> [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/consensus-spec-tests/tree/master/tests/general)
## Contributing
Please check out [CONTRIBUTING.md](./CONTRIBUTING.md) for more info on how to use the repo and for architectural details
## Release/Publishing
## Release
The release process is automatically [triggered](.github/workflows/CI.yml#216) when the master branch has the version in package.json updated.
To create a new release:
1. Increment the project version in [package.json](package.json#3)
- A pre-release can be published by ensuring that the project version is appended with non-numeric characters, eg: `-beta`
2. run `yarn run version`
3. merge a commit with these changes
4. CI will run and result in a new release being published
## License
Apache-2.0