mirror of
https://github.com/AtHeartEngineering/lodestar.git
synced 2026-01-09 01:28:11 -05:00
docs: revamp readme, security, and contributing (#3128)
* docs: update readme * docs: update security * docs: update readme * docs: update contributing * docs: update contributing * docs: update security * docs: add new packages to readme
This commit is contained in:
Afr Schoe
@@ -1,26 +1,28 @@
|
||||
# Introduction
|
||||
# Contribution Guidlines
|
||||
|
||||
> Thanks for your contribution to Lodestar. It's people like you that push the Ethereum ecosystem forward.
|
||||
Thanks for your contribution to Lodestar. It's people like you that push the Ethereum ecosystem forward.
|
||||
|
||||
# Prerequisites
|
||||
## Prerequisites
|
||||
|
||||
- [Lerna](https://github.com/lerna/lerna)
|
||||
- [Yarn](https://yarnpkg.com/)
|
||||
- :gear: [NodeJS](https://nodejs.org/) (LTS/Fermium)
|
||||
- :toolbox: [Yarn](https://yarnpkg.com/)/[Lerna](https://lerna.js.org/)
|
||||
|
||||
# Getting Started
|
||||
## Getting Started
|
||||
|
||||
- Run `lerna bootstrap` or `yarn install` to install dependencies
|
||||
- Run `yarn build` to build lib from source
|
||||
- :gear: Run `lerna bootstrap` or `yarn install` to install dependencies.
|
||||
- :gear: Run `yarn build` to build lib from source.
|
||||
- :package: A `lodestar` binary will be bundled in `./packages/cli/bin`.
|
||||
- :computer: Run `./lodestar --help` to get a list of available commands and argurments.
|
||||
|
||||
# Tests
|
||||
## Tests
|
||||
|
||||
- Run `lerna run test:spec-min` for minimal spec tests
|
||||
- Run `lerna run test:spec-main` for mainnet spec tests
|
||||
- Run `lerna run test:unit` for unit tests
|
||||
- Run `lerna run test:e2e` for end-to-end tests
|
||||
- Run `lerna run test` to run all tests
|
||||
- :test_tube: Run `lerna run test:spec-min` for minimal spec tests.
|
||||
- :test_tube: Run `lerna run test:spec-main` for mainnet spec tests.
|
||||
- :test_tube: Run `lerna run test:unit` for unit tests.
|
||||
- :test_tube: Run `lerna run test:e2e` for end-to-end tests.
|
||||
- :test_tube: Run `lerna run test` to run all tests.
|
||||
|
||||
# Docker
|
||||
## Docker
|
||||
|
||||
The docker-compose file requires that a `.env` file be present in this directory. The `default.env` file provides a template and can be copied `.env`:
|
||||
|
||||
@@ -28,13 +30,13 @@ The docker-compose file requires that a `.env` file be present in this directory
|
||||
cp default.env .env
|
||||
```
|
||||
|
||||
**Beacon node only**
|
||||
###### Beacon node only:
|
||||
|
||||
```
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
**Beacon node and validator**
|
||||
###### Beacon node and validator:
|
||||
|
||||
First, you must have keystores and their secrets available locally at `./keystores` and `./secrets`
|
||||
|
||||
@@ -42,44 +44,45 @@ First, you must have keystores and their secrets available locally at `./keystor
|
||||
docker-compose -f docker-compose.yml -f docker-compose.validator.yml up -d
|
||||
```
|
||||
|
||||
**Dockerized metrics + local beacon node**
|
||||
###### Dockerized metrics + local beacon node:
|
||||
|
||||
```
|
||||
docker-compose -f docker/docker-compose.local.yml up -d
|
||||
```
|
||||
|
||||
# First-time Contributor?
|
||||
## First-time Contributor?
|
||||
|
||||
Unsure where to begin contributing to Lodestar? Here are some ideas!
|
||||
|
||||
- See any typos? See any verbiage that should be changed or updated? Go for it! Github makes it easy to make contributions right from the browser.
|
||||
- Look through our [outstanding unassigned issues](https://github.com/ChainSafe/lodestar/issues?q=is%3Aopen+is%3Aissue+no%3Aassignee). (hint: look for issues labeled "good first issue")
|
||||
- Join our [discord chat](https://discord.gg/aMxzVcr)!
|
||||
- :pencil2: See any typos? See any verbiage that should be changed or updated? Go for it! Github makes it easy to make contributions right from the browser.
|
||||
- :mag_right: Look through our [outstanding unassigned issues](https://github.com/ChainSafe/lodestar/issues?q=is%3Aopen+is%3Aissue+no%3Aassignee). _(Hint: look for issues labeled "good first issue"!)_
|
||||
- :speech_balloon: Join our [Discord chat](https://discord.gg/aMxzVcr)!
|
||||
[](https://discord.gg/aMxzVcr)
|
||||
|
||||
# Reporting a bug?
|
||||
## Reporting a bug?
|
||||
|
||||
[Create a new issue!](https://github.com/ChainSafe/lodestar/issues/new/choose) Select the type of issue that best fits, and please fill out as much of the information as you can.
|
||||
- :spiral_notepad: [Create a new issue!](https://github.com/ChainSafe/lodestar/issues/new/choose) Select the type of issue that best fits, and please fill out as much of the information as you can.
|
||||
|
||||
# Contribution process
|
||||
## Contribution process
|
||||
|
||||
1. Make sure you're familiar with our contribution guidelines (this document!)
|
||||
2. Create your [own fork](https://github.com/ChainSafe/lodestar/fork) of this repo
|
||||
3. Make your changes in your local fork
|
||||
4. If you've made a code change, make sure to lint and test your changes (`yarn lint` and `yarn test:unit`)
|
||||
1. Make sure you're familiar with our contribution guidelines _(this document)_!
|
||||
2. Create your [own fork](https://github.com/ChainSafe/lodestar/fork) of this repository.
|
||||
3. Make your changes in your local fork.
|
||||
4. If you've made a code change, make sure to lint and test your changes (`yarn lint` and `yarn test:unit`).
|
||||
5. Make a pull request! We review PRs on a regular basis.
|
||||
6. You may be asked to sign a Contributor License Agreement (CLA). We make it relatively painless with CLA-bot.
|
||||
|
||||
# Lodestar Monorepo
|
||||
## Lodestar Monorepo
|
||||
|
||||
We're currently experimenting with hosting the majority of lodestar packages and support packages in this repository as a [monorepo](https://en.wikipedia.org/wiki/Monorepo). We're using [Lerna](https://lerna.js.org/) to manage the packages.
|
||||
See [packages/](https://github.com/ChainSafe/lodestar/tree/master/packages) for a list of packages hosted in this repo.
|
||||
We're currently experimenting with hosting the majority of lodestar packages and support packages in this repository as a [monorepo](https://en.wikipedia.org/wiki/Monorepo). We're using [Lerna](https://lerna.js.org/) to manage the packages. See [packages/](https://github.com/ChainSafe/lodestar/tree/master/packages) for a list of packages hosted in this repo.
|
||||
|
||||
# Style Guide
|
||||
## Style Guide
|
||||
|
||||
- PRs should usually only update a single package (in our monorepo) at a time
|
||||
- Pull requests should usually only update a single package (in our monorepo) at a time
|
||||
- prefix your PR title with the module you are working on, e.g.: `validator: foo bar buz`
|
||||
- Many module class constructors have the following signature: `(options, dependencies)`
|
||||
- eg: `public constructor(opts: IExampleOptions, {db, logger}: IExampleModules)`
|
||||
- Modules should be designed to "do one thing and do it well"
|
||||
- e.g.: `public constructor(opts: IExampleOptions, {db, logger}: IExampleModules)`
|
||||
- Modules should be designed to _"do one thing and do it well!"_
|
||||
- Consider the interface of a module -- events included, and make sure it is coherent
|
||||
- Make sure your code is properly linted
|
||||
- use an IDE that will show linter errors/warnings
|
||||
@@ -89,16 +92,16 @@ See [packages/](https://github.com/ChainSafe/lodestar/tree/master/packages) for
|
||||
- Use `"` instead of `'`
|
||||
- All functions should have types declared for all parameters and return value
|
||||
- All interfaces should be prefixed with a `I`
|
||||
- eg: `IMyInterface`
|
||||
- You probably shouldn't be using Typescript's `any`
|
||||
- e.g.: `IMyInterface`
|
||||
- You shouldn't be using TypeScript's `any`
|
||||
- Private class properties should not be prefixed with a `_`
|
||||
- eg: `private dirty;`, not `private _dirty;`
|
||||
- e.g.: `private dirty;`, not `private _dirty;`
|
||||
- Make sure that your code is properly type checked:
|
||||
- use an IDE that will show type errors
|
||||
- run `yarn check-types` from the command line
|
||||
- Make sure that the tests are still passing:
|
||||
- run `yarn test:unit` from the command line
|
||||
|
||||
# Community
|
||||
## Community
|
||||
|
||||
Come chat with us on [discord](https://discord.gg/aMxzVcr)!
|
||||
Come chat with us on [Discord](https://discord.gg/aMxzVcr) and join our public weekly planning meetings!
|
||||
|
||||
2
LICENSE
2
LICENSE
@@ -162,4 +162,4 @@ General Public License ever published by the Free Software Foundation.
|
||||
whether future versions of the GNU Lesser General Public License shall
|
||||
apply, that proxy's public statement of acceptance of any version is
|
||||
permanent authorization for you to choose that version for the
|
||||
Library.
|
||||
Library.
|
||||
|
||||
116
README.md
116
README.md
@@ -1,76 +1,86 @@
|
||||
<p align="center"><a href="https://chainsafe.github.io/lodestar"><img width="500" title="Lodestar" src='assets/lodestar_icon_text_black_stroke.png' /></a></p>
|
||||
|
||||
# Lodestar Monorepo
|
||||
# Lodestar Eth2 Implementation
|
||||
|
||||
|
||||
[](https://discord.gg/aMxzVcr)
|
||||
[](https://github.com/ChainSafe/lodestar/releases/latest)
|
||||
[](https://www.npmjs.com/package/@chainsafe/lodestar-cli)
|
||||
[](https://hub.docker.com/r/chainsafe/lodestar)
|
||||
[](https://github.com/ethereum/consensus-specs/releases/tag/v1.1.0-beta.3)
|
||||
[](https://codecov.io/gh/ChainSafe/lodestar)
|
||||
[](https://codeclimate.com/github/ChainSafe/lodestar/maintainability)
|
||||
|
||||
|
||||
|
||||
|
||||
[Lodestar](https://lodestar.chainsafe.io) is a Typescript implementation of the Ethereum 2.0 specification developed by [ChainSafe Systems](https://chainsafe.io).
|
||||
[Lodestar](https://lodestar.chainsafe.io) is a TypeScript implementation of the [Ethereum 2.0 specification](https://github.com/ethereum/consensus-specs) developed by [ChainSafe Systems](https://chainsafe.io).
|
||||
|
||||
## Index
|
||||
###### Get it from the NPM Registry:
|
||||
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Contributors](#contributors)
|
||||
- [Meeting Notes](#meeting-notes)
|
||||
- [Donations](#donations)
|
||||
- [Packages](#packages)
|
||||
- [Creating Release](#creating-release)
|
||||
```bash
|
||||
npm install -g @chainsafe/lodestar-cli
|
||||
```
|
||||
|
||||
###### Get it from the Docker Hub:
|
||||
|
||||
```bash
|
||||
docker pull chainsafe/lodestar
|
||||
```
|
||||
|
||||
## Getting started
|
||||
|
||||
- Follow the [installation guide](https://chainsafe.github.io/lodestar/installation) to install Lodestar.
|
||||
- Run lodestar on the [eth2 mainnet or on a public testnet](https://chainsafe.github.io/lodestar/usage/testnet/)
|
||||
- Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/usage/local).
|
||||
- View the lodestar [cli commands and options](https://chainsafe.github.io/lodestar/reference/cli/)
|
||||
- View the [typedoc code docs](https://chainsafe.github.io/lodestar/packages).
|
||||
- If you have questions [submit an issue](https://github.com/ChainSafe/lodestar/issues/new) or join us on [discord](https://discord.gg/yjyvFRP)!
|
||||
- :gear: Follow the [installation guide](https://chainsafe.github.io/lodestar/installation) to install Lodestar.
|
||||
- :globe_with_meridians: Run lodestar on the [Eth2 mainnet or on a public testnet](https://chainsafe.github.io/lodestar/usage/testnet/).
|
||||
- :computer: Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/usage/local).
|
||||
- :spiral_notepad: View the lodestar [CLI commands and options](https://chainsafe.github.io/lodestar/reference/cli/).
|
||||
- :nerd_face: View the [TypeDoc code documentation](https://chainsafe.github.io/lodestar/packages).
|
||||
- :writing_hand: If you have questions [submit an issue](https://github.com/ChainSafe/lodestar/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP)!
|
||||
[](https://discord.gg/aMxzVcr)
|
||||
- :rotating_light: Please note our [security policy](./SECURITY.md).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- [Yarn](https://yarnpkg.com/)
|
||||
- :gear: [NodeJS](https://nodejs.org/) (LTS/Fermium)
|
||||
- :toolbox: [Yarn](https://yarnpkg.com/)/[Lerna](https://lerna.js.org/)
|
||||
|
||||
###### Developer Quickstart:
|
||||
|
||||
```bash
|
||||
lerna bootstrap
|
||||
yarn build
|
||||
./lodestar --help
|
||||
```
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
- See [architecure docs](https://chainsafe.github.io/lodestar/design/architecture/) for Lodestar
|
||||
|
||||
## Contributors
|
||||
|
||||
Read our [contributors document](/CONTRIBUTING.md), [submit an issue](https://github.com/ChainSafe/lodestar/issues/new/choose) or talk to us on our [discord](https://discord.gg/yjyvFRP)!
|
||||
|
||||
## Meeting Notes
|
||||
|
||||
Feel free to check out our meeting notes and documents on [HackMD](https://hackmd.io/@wemeetagain/rJTEOdqPS/%2F%40yBpKEsxORheI8AJoIiZj1Q%2FHk_b8XfcV%2F%252F6pRB5amJRLKBGEkeOJA8Cw).
|
||||
|
||||
## Donations
|
||||
|
||||
We are a local group of Toronto open source developers. As such, all of our open source work is funded by grants. We all take the time out of our hectic lives to contribute to the Ethereum ecosystem.
|
||||
If you want to donate, you can send us ETH at the following address: **lodestar.chainsafe.eth**
|
||||
|
||||
## Packages
|
||||
|
||||
This monorepo repository contains a suite of Ethereum 2.0 packages.
|
||||
- :package: This mono-repository contains a suite of Ethereum 2.0 packages.
|
||||
- :triangular_ruler: The [architecure docs](https://chainsafe.github.io/lodestar/design/architecture/) for Lodestar should give an overview over the node modules.
|
||||
- :balance_scale: The mono-repositoy is released under [LGPLv3 license](./LICENSE). Note, that the packages contain their own licenses.
|
||||
|
||||
| Package | Version | License | Docs | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------- |
|
||||
| [@chainsafe/lodestar](https://github.com/ChainSafe/lodestar/tree/master/packages/lodestar) | [](https://www.npmjs.com/package/@chainsafe/lodestar) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://chainsafe.github.io/lodestar/lodestar) | Beacon chain client |
|
||||
| [@chainsafe/lodestar-validator](https://github.com/ChainSafe/lodestar/tree/master/packages/validator) | [](https://www.npmjs.com/package/@chainsafe/lodestar-validator) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://chainsafe.github.io/lodestar/lodestar-validator) | Validator client |
|
||||
| [@chainsafe/lodestar-cli](https://github.com/ChainSafe/lodestar/tree/master/packages/cli) | [](https://www.npmjs.com/package/@chainsafe/lodestar-cli) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://chainsafe.github.io/lodestar/lodestar-cli) | Command line tool for lodestar |
|
||||
| [@chainsafe/lodestar-beacon-state-transition](https://github.com/ChainSafe/lodestar/tree/master/packages/beacon-state-transition) | [](https://www.npmjs.com/package/@chainsafe/lodestar-beacon-state-transition) | [](https://opensource.org/licenses/Apache-2.0) | [](https://github.com/ChainSafe/lodestar/tree/master/packages/beacon-state-transition) | Eth2 beacon state transition |
|
||||
| [@chainsafe/lodestar-types](https://github.com/ChainSafe/lodestar/tree/master/packages/types) | [](https://www.npmjs.com/package/@chainsafe/lodestar-types) | [](https://opensource.org/licenses/Apache-2.0) | [](https://github.com/ChainSafe/lodestar/tree/master/packages/types) | Eth2 typescript and SSZ types |
|
||||
| [@chainsafe/lodestar-params](https://github.com/ChainSafe/lodestar/tree/master/packages/params) | [](https://www.npmjs.com/package/@chainsafe/lodestar-params) | [](https://opensource.org/licenses/Apache-2.0) | [](https://github.com/ChainSafe/lodestar/tree/master/packages/params) | Eth2 network parameters |
|
||||
| [@chainsafe/lodestar-utils](https://github.com/ChainSafe/lodestar/tree/master/packages/utils) | [](https://www.npmjs.com/package/@chainsafe/lodestar-utils) | [](https://opensource.org/licenses/Apache-2.0) | [](https://chainsafe.github.io/lodestar/lodestar-utils) | Misc utility functions used across lodestar |
|
||||
| [@chainsafe/lodestar-config](https://github.com/ChainSafe/lodestar/tree/master/packages/config) | [](https://www.npmjs.com/package/@chainsafe/lodestar-config) | [](https://opensource.org/licenses/Apache-2.0) | [](https://chainsafe.github.io/lodestar/lodestar-config) | Eth2 types and params bundled together |
|
||||
| [@chainsafe/lodestar-spec-test-util](https://github.com/ChainSafe/lodestar/tree/master/packages/spec-test-util) | [](https://www.npmjs.com/package/@chainsafe/lodestar-spec-test-util) | [](https://opensource.org/licenses/Apache-2.0) | [](https://chainsafe.github.io/lodestar/lodestar-spec-test-util) | Test harness for Eth2 spec tests |
|
||||
| [@chainsafe/lodestar-db](https://github.com/ChainSafe/lodestar/tree/master/packages/db) | [](https://www.npmjs.com/package/@chainsafe/lodestar-db) | [](https://opensource.org/licenses/Apache-2.0) | [](https://chainsafe.github.io/lodestar/lodestar-db) | Read/write persistent Eth2 data |
|
||||
| [@chainsafe/lodestar-fork-choice](https://github.com/ChainSafe/lodestar/tree/master/packages/fork-choice) | [](https://www.npmjs.com/package/@chainsafe/lodestar-fork-choice) | [](https://opensource.org/licenses/Apache-2.0) | [](https://chainsafe.github.io/lodestar/lodestar-fork-choice) | Beacon chain fork choice |
|
||||
| [@chainsafe/lodestar](https://github.com/ChainSafe/lodestar/tree/master/packages/lodestar) | [](https://www.npmjs.com/package/@chainsafe/lodestar) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://chainsafe.github.io/lodestar) | :rotating_light: Beacon-chain client |
|
||||
| [@chainsafe/lodestar-validator](https://github.com/ChainSafe/lodestar/tree/master/packages/validator) | [](https://www.npmjs.com/package/@chainsafe/lodestar-validator) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://github.com/ChainSafe/lodestar/tree/master/packages/validator) | :bank: Validator client |
|
||||
| [@chainsafe/lodestar-light-client](https://github.com/ChainSafe/lodestar/tree/master/packages/light-client) | [](https://www.npmjs.com/package/@chainsafe/lodestar-light-client) | [](https://opensource.org/licenses/Apache-2.0) | [](https://github.com/ChainSafe/lodestar/tree/master/packages/light-client) | :bird: Eth2 Light client |
|
||||
| [@chainsafe/lodestar-api](https://github.com/ChainSafe/lodestar/tree/master/packages/api) | [](https://www.npmjs.com/package/@chainsafe/lodestar-api) | [](https://opensource.org/licenses/Apache-2.0) | [](https://github.com/ChainSafe/lodestar/tree/master/packages/api) | :clipboard: REST Client for the Eth2 API |
|
||||
| [@chainsafe/lodestar-cli](https://github.com/ChainSafe/lodestar/tree/master/packages/cli) | [](https://www.npmjs.com/package/@chainsafe/lodestar-cli) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://chainsafe.github.io/lodestar/reference/cli/) | :computer: Command-line tool for Lodestar |
|
||||
| [@chainsafe/lodestar-beacon-state-transition](https://github.com/ChainSafe/lodestar/tree/master/packages/beacon-state-transition) | [](https://www.npmjs.com/package/@chainsafe/lodestar-beacon-state-transition) | [](https://www.gnu.org/licenses/lgpl-3.0) | [](https://github.com/ChainSafe/lodestar/tree/master/packages/beacon-state-transition) | :mag_right: Eth2 beacon-state transition |
|
||||
| [@chainsafe/lodestar-types](https://github.com/ChainSafe/lodestar/tree/master/packages/types) | [](https://www.npmjs.com/package/@chainsafe/lodestar-types) | [](https://opensource.org/licenses/Apache-2.0) | [](https://github.com/ChainSafe/lodestar/tree/master/packages/types) | :spiral_notepad: Eth2 TypeScript and SSZ types |
|
||||
| [@chainsafe/lodestar-params](https://github.com/ChainSafe/lodestar/tree/master/packages/params) | [](https://www.npmjs.com/package/@chainsafe/lodestar-params) | [](https://opensource.org/licenses/Apache-2.0) | [](https://github.com/ChainSafe/lodestar/tree/master/packages/params) | :spider_web: Eth2 network parameters |
|
||||
| [@chainsafe/lodestar-utils](https://github.com/ChainSafe/lodestar/tree/master/packages/utils) | [](https://www.npmjs.com/package/@chainsafe/lodestar-utils) | [](https://opensource.org/licenses/Apache-2.0) | [](https://github.com/ChainSafe/lodestar/tree/master/packages/utils) | :toolbox: Miscellaneous utility functions used across Lodestar |
|
||||
| [@chainsafe/lodestar-config](https://github.com/ChainSafe/lodestar/tree/master/packages/config) | [](https://www.npmjs.com/package/@chainsafe/lodestar-config) | [](https://opensource.org/licenses/Apache-2.0) | [](https://github.com/ChainSafe/lodestar/tree/master/packages/config) | :spiral_notepad: Eth2 types and params bundled together |
|
||||
| [@chainsafe/lodestar-spec-test-util](https://github.com/ChainSafe/lodestar/tree/master/packages/spec-test-util) | [](https://www.npmjs.com/package/@chainsafe/lodestar-spec-test-util) | [](https://opensource.org/licenses/Apache-2.0) | [](https://github.com/ChainSafe/lodestar/tree/master/packages/spec-test-util) | :test_tube: Test harness for Eth2 spec tests |
|
||||
| [@chainsafe/lodestar-spec-test-runner](https://github.com/ChainSafe/lodestar/tree/master/packages/spec-test-runner) | | [](https://www.gnu.org/licenses/lgpl-3.0) | | :test_tube: Run all Eth2 spec tests |
|
||||
| [@chainsafe/lodestar-db](https://github.com/ChainSafe/lodestar/tree/master/packages/db) | [](https://www.npmjs.com/package/@chainsafe/lodestar-db) | [](https://opensource.org/licenses/Apache-2.0) | [](https://github.com/ChainSafe/lodestar/tree/master/packages/db) | :floppy_disk: Read/write persistent Eth2 data |
|
||||
| [@chainsafe/lodestar-fork-choice](https://github.com/ChainSafe/lodestar/tree/master/packages/fork-choice) | [](https://www.npmjs.com/package/@chainsafe/lodestar-fork-choice) | [](https://opensource.org/licenses/Apache-2.0) | [](https://github.com/ChainSafe/lodestar/tree/master/packages/fork-choice) | :fork_and_knife: Beacon-chain fork choice |
|
||||
|
||||
### Creating Release
|
||||
## Contributors
|
||||
|
||||
- run `yarn run release` in project root directory
|
||||
- choose version increment
|
||||
- open PR to master
|
||||
Read our [contributors document](/CONTRIBUTING.md), [submit an issue](https://github.com/ChainSafe/lodestar/issues/new/choose) or talk to us on our [Discord](https://discord.gg/yjyvFRP)!
|
||||
|
||||
## Meetings
|
||||
|
||||
Weekly contributor meetings are public and announced on Discord. Feel free to check out our meeting notes and documents on [HackMD](https://hackmd.io/@wemeetagain/rJTEOdqPS/%2FXBzvaQgMTyyMJuToWAEDjw).
|
||||
|
||||
## Donations
|
||||
|
||||
We are a local group of Toronto open-source developers. As such, all of our open-source work is funded by grants. We all take the time out of our hectic lives to contribute to the Ethereum ecosystem.
|
||||
If you want to donate, you can send us ETH at the following address: `lodestar.chainsafe.eth`
|
||||
|
||||
@@ -2,10 +2,10 @@
|
||||
|
||||
## Supported Versions
|
||||
|
||||
Please see [Releases](https://github.com/ChainSafe/lodestar/releases/). We recommend using the [most recently released version](https://github.com/ChainSafe/lodestar/releases/latest).
|
||||
- :hourglass_flowing_sand: Lodestar currently undergoes a quick release cycle with regular minor alpha releases published fortnightly.
|
||||
- :globe_with_meridians: We encourage using the [most recently released version](https://github.com/ChainSafe/lodestar/releases/latest) before reporting an issue.
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
Please send vulnerability reports to security@chainsafe.io.
|
||||
|
||||
**Please do not file a public ticket** mentioning the vulnerability, as doing so could increase the likelihood of the vulnerability being used before a fix has been created, released and installed on the network.
|
||||
- :rotating_light: Please, send vulnerability reports to `security@chainsafe.io`.
|
||||
- :warning: **Please do not file a public ticket** mentioning the vulnerability, as doing so could increase the likelihood of the vulnerability being used before a fix has been created, released and installed on the network.
|
||||
|
||||
Reference in New Issue
Block a user