https://github.com/chainsafe/bls-keygen
Key management for BLS curves written in TypeScript and browser compatible
https://github.com/chainsafe/bls-keygen
bls eip-2333 eip-2334 ethereum
Last synced: 3 months ago
JSON representation
Key management for BLS curves written in TypeScript and browser compatible
- Host: GitHub
- URL: https://github.com/chainsafe/bls-keygen
- Owner: ChainSafe
- License: apache-2.0
- Created: 2019-11-07T15:38:42.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-31T14:38:37.000Z (10 months ago)
- Last Synced: 2025-10-10T20:52:42.821Z (4 months ago)
- Topics: bls, eip-2333, eip-2334, ethereum
- Language: TypeScript
- Homepage:
- Size: 361 KB
- Stars: 21
- Watchers: 10
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# BLS Keygen
[](https://discord.gg/aMxzVcr)
Utility functions for generating BLS secret keys, built for NodeJs and Browser.
- Create a master key from BIP-39 mnemonic or entropy.
- Create a derived child key from BIP-39 mnemonic, entropy, or a master key.
- Create Eth2 validator keys from a master key.
Implementation follows EIPS: [EIP-2334](https://github.com/ethereum/EIPs/pull/2334), [EIP-2333](https://github.com/ethereum/EIPs/pull/2333)
For low-level [EIP-2333](https://github.com/ethereum/EIPs/pull/2333) and [EIP-2334](https://github.com/ethereum/EIPs/pull/2334) functionality, see [@chainsafe/bls-hd-key](https://github.com/chainsafe/bls-hd-key).
### Examples
```typescript
import {
generateRandomSecretKey,
deriveKeyFromMnemonic,
deriveKeyFromEntropy,
deriveKeyFromMaster,
deriveEth2ValidatorKeys,
} from "@chainsafe/bls-keygen";
// random secret key
const secretKey = generateRandomSecretKey();
...
// secret key from mnemonic and optional EIP-2334 path
const masterSecretKey = deriveKeyFromMnemonic(
"impact exit example acquire drastic cement usage float mesh source private bulb twenty guitar neglect",
);
const childSecretKey = deriveKeyFromMnemonic(
"impact exit example acquire drastic cement usage float mesh source private bulb twenty guitar neglect",
"m/12381/3600/0/0"
);
...
// secret key from entropy and optional EIP-2334 path
const masterSecretKey = deriveKeyFromEntropy(entropy);
const childSecretKey = deriveKeyFromEntropy(
entropy,
"m/12381/3600/0/0"
);
...
// child secret key from master secret key and EIP-2334 path
const childSecretKey = deriveKeyFromMaster(
masterSecretKey,
"m/12381/3600/0/0"
);
...
// create multiple eth2 validator keys from a master secret key
const keys0 = deriveEth2ValidatorKeys(masterSecretKey, 0);
const keys1 = deriveEth2ValidatorKeys(masterSecretKey, 1);
const { signing, withdrawal } = keys0;
```
### Contribution
Requirements:
- nodejs
- yarn
```bash
yarn install
yarn run test
```
### Audit
This repo was audited by Least Authority as part of [this security audit](https://github.com/ChainSafe/lodestar/blob/master/audits/2020-03-23_UTILITY_LIBRARIES.pdf), released 2020-03-23. Commit [`32b068`](https://github.com/ChainSafe/bls-hd-key/commit/32b068) verified in the report.
### License
Apache-2.0