@ChainSafe/bls-keystore

Typescript implementation of EIP 2335 for node and browser.

How to use?

Functional interface

1import {Buffer} from "buffer";
2import {
3  IKeystore,
4  create,
5  decrypt,
6  verifyPassword,
7  isValidKeystore,
8  validateKeystore,
9} from "@chainsafe/bls-keystore";
10
11// encrypt private key
12const password: string | Uint8Array = "SomePassword123"; 
13const privateKey: Uint8Array = ...;
14const publicKey: Uint8Array = ...;
15const path: string = "m/12381/60/0/0";
16
17// keystore is an `object` that follows the EIP-2335 schema
18const keystore: IKeystore = await create(password, privateKey, publicKey, path);
19
20// verify password
21await verifyPassword(keystore, password); //true | false
22
23// decrypt
24const decryptedPrivateKey: Buffer = await decrypt(keystore, password);
25
26// convert to string
27JSON.stringify(keystore); //string
28
29// determine if unsanitized data fits the EIP-2335 schema
30const data: unknown = ...;
31isValidKeystore(data); // true | false
32
33validateKeystore(data); // throws if invalid

Class-based interface

1import {Buffer} from "buffer";
2import {
3  Keystore,
4} from "@chainsafe/bls-keystore";
5
6// encrypt private key
7const password: string | Uint8Array = "SomePassword123"; 
8const privateKey: Uint8Array = ...;
9const publicKey: Uint8Array = ...;
10const path: string = "m/12381/60/0/0";
11
12// keystore is a `Keystore` instance that follows the EIP-2335 schema with additional convenience methods
13const keystore: Keystore = await Keystore.create(password, privateKey, publicKey, path);
14
15// verify password
16await keystore.verifyPassword(password); //true | false
17
18// decrypt
19const decryptedPrivateKey: Buffer = await keystore.decrypt(password);
20
21// convert to string
22keystore.stringify(); //string
23
24// determine if unsanitized data fits the EIP-2335 schema
25const data: unknown = ...;
26Keystore.fromObject(data); // returns a Keystore or throws if data is invalid

For key derivation checkout @chainsafe/bls-keygen

Contribute

• get yarn
• yarn install
• yarn test