Update README and package.json
This commit is contained in:
parent
5cce2283c6
commit
b297740f00
23
README.md
23
README.md
|
@ -1,18 +1,7 @@
|
||||||
### ChainSafe ETH2.0 Projects
|
|
||||||
Note:
|
|
||||||
There is a lot of work being done that are core infrastructural pieces for Eth2.0. Contributions to any of the below repositories would be greatly appreciated. All the libraries are written in TypeScript (or in the process of being converted from pure JS to TypeScript):
|
|
||||||
<br />
|
|
||||||
-- [PM / Meta Repo](https://github.com/ChainSafe/Sharding)<br />
|
|
||||||
|-- [Beacon Chain](https://github.com/ChainSafe/lodestar_chain)<br />
|
|
||||||
|-- [Simple Serialize (SSZ)](https://github.com/ChainSafe/ssz-js)<br />
|
|
||||||
|-- [Fixed Size Numbers](https://github.com/ChainSafe/fixed-sized-numbers-ts/)<br />
|
|
||||||
|-- [BLS Signatures and Signature Aggregation](https://github.com/ChainSafe/bls-js)<br />
|
|
||||||
|
|
||||||
# bls-js
|
# bls-js
|
||||||
|
|
||||||
[![Build Status](https://travis-ci.org/ChainSafe/bls-js.svg?branch=master)](https://travis-ci.org/ChainSafe/bls-js)
|
[![Build Status](https://travis-ci.org/ChainSafe/lodestar.svg?branch=master)](https://travis-ci.org/ChainSafe/lodestar)
|
||||||
[![codecov](https://codecov.io/gh/ChainSafe/bls-js/branch/master/graph/badge.svg)](https://codecov.io/gh/ChainSafe/bls-js)
|
[![codecov](https://codecov.io/gh/ChainSafe/lodestar/branch/master/graph/badge.svg)](https://codecov.io/gh/ChainSafe/lodestar)
|
||||||
[![](https://badges.gitter.im/chainsafe/lodestar.svg)](https://gitter.im/chainsafe/lodestar?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
||||||
![ETH2.0_Spec_Version 0.8.0](https://img.shields.io/badge/ETH2.0_Spec_Version-0.8.0-2e86c1.svg)
|
![ETH2.0_Spec_Version 0.8.0](https://img.shields.io/badge/ETH2.0_Spec_Version-0.8.0-2e86c1.svg)
|
||||||
|
|
||||||
This is a Javascript library that implements BLS (Boneh-Lynn-Shacham) signatures and supports signature aggregation.
|
This is a Javascript library that implements BLS (Boneh-Lynn-Shacham) signatures and supports signature aggregation.
|
||||||
|
@ -25,7 +14,7 @@ This is a Javascript library that implements BLS (Boneh-Lynn-Shacham) signatures
|
||||||
- `yarn add @chainsafe/bls`
|
- `yarn add @chainsafe/bls`
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
- `git clone --recursive git@github.com:ChainSafe/bls-js.git`
|
- `git clone --recursive git@github.com:ChainSafe/lodestar.git`
|
||||||
- `yarn install`
|
- `cd lodestar`
|
||||||
- `yarn test`
|
- `lerna bootstrap`
|
||||||
|
- `cd packages/bls`
|
||||||
|
|
10
package.json
10
package.json
|
@ -4,7 +4,7 @@
|
||||||
"description": "Implementation of bls signature verification for ethereum 2.0",
|
"description": "Implementation of bls signature verification for ethereum 2.0",
|
||||||
"main": "lib/index.js",
|
"main": "lib/index.js",
|
||||||
"types": "lib/index.d.ts",
|
"types": "lib/index.d.ts",
|
||||||
"homepage": "https://github.com/chainsafe/bls-js",
|
"homepage": "https://github.com/chainsafe/lodestar",
|
||||||
"author": "ChainSafe Systems",
|
"author": "ChainSafe Systems",
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"files": [
|
"files": [
|
||||||
|
@ -27,10 +27,10 @@
|
||||||
"lint-fix": "eslint --ext .ts src/ --fix",
|
"lint-fix": "eslint --ext .ts src/ --fix",
|
||||||
"pretest": "yarn check-types",
|
"pretest": "yarn check-types",
|
||||||
"prepublishOnly": "yarn build",
|
"prepublishOnly": "yarn build",
|
||||||
"test:unit": "mocha -r ./.babel-register \"test/unit/**/*.test.ts\"",
|
"test:unit": "nyc --cache-dir .nyc_output/.cache -r lcov -e .ts mocha -r ./.babel-register 'test/unit/**/*.test.ts' && nyc report",
|
||||||
"test:spec": "mocha -r ./.babel-register \"test/spec/**/*.test.ts\"",
|
"test:spec": "mocha -r ./.babel-register 'test/spec/**/*.test.ts'",
|
||||||
"test": "nyc -r lcov -e .ts -x \"*.test.ts\" mocha -r ./.babel-register \"test/**/*.test.ts\" && nyc report",
|
"test": "yarn test:unit && yarn test:spec",
|
||||||
"coverage": "codecov"
|
"coverage": "codecov -F bls"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@chainsafe/milagro-crypto-js": "0.1.3",
|
"@chainsafe/milagro-crypto-js": "0.1.3",
|
||||||
|
|
Reference in New Issue