Merge pull request #4217 from ChainSafe/rc/v0.39.0

v0.39.0

.eslintrc.js

@@ -182,6 +182,8 @@ module.exports = {
       files: ["**/test/**/*.ts"],
       rules: {
         "import/no-extraneous-dependencies": "off",
+        // Turned off as it floods log with warnings. Underlying issue is not critical so switching off is acceptable
+        "import/no-named-as-default-member": "off",
         "@typescript-eslint/no-explicit-any": "off",
         "func-names": "off",
       },

.github/workflows/publish-rc.yml

@@ -121,7 +121,6 @@ jobs:
         with:
           id: ${{ steps.create_release.outputs.id }}
           tag: ${{ needs.tag.outputs.tag }}
-          delete_orphan_tag: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

.github/workflows/publish-stable.yml

@@ -111,7 +111,6 @@ jobs:
         with:
           id: ${{ steps.create_release.outputs.id }}
           tag: ${{ needs.tag.outputs.tag }}
-          delete_orphan_tag: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

.github/workflows/test-sim-merge.yml

@@ -3,8 +3,8 @@ name: Sim merge tests
 on: [pull_request, push]
 
 env:
-  GETH_COMMIT: bb5633c5ee3975ce016636066ec790054ec469e4
-  NETHERMIND_COMMIT: 00b50532543824dbac65e8b7ab09484e44992c27
+  GETH_COMMIT: be9742721f56eb8bb7ebf4f6a03fb01b13a05408
+  NETHERMIND_COMMIT: 82f331a3e7ff21712a5f839e0a62ba7c16110e44
 
 jobs:
   sim-merge-tests:
@@ -59,7 +59,7 @@ jobs:
         with:
           dotnet-version: "6.0.x"
       - name: Clone Nethermind merge interop branch
-        run: git clone -b kiln https://github.com/g11tech/nethermind --recursive && cd nethermind && git reset --hard $NETHERMIND_COMMIT && git submodule update --init --recursive
+        run: git clone -b kiln-rebased https://github.com/g11tech/nethermind --recursive && cd nethermind && git reset --hard $NETHERMIND_COMMIT && git submodule update --init --recursive
       - name: Build Nethermind
         run: cd nethermind/src/Nethermind && dotnet build Nethermind.sln -c Release
 

README.md

@@ -13,25 +13,15 @@
 
 [Lodestar](https://lodestar.chainsafe.io) is a TypeScript implementation of the [Ethereum Consensus specification](https://github.com/ethereum/consensus-specs) developed by [ChainSafe Systems](https://chainsafe.io).
 
-###### Get it from the NPM Registry:
-
-```bash
-npm install -g @chainsafe/lodestar-cli
-```
-
-###### Get it from the Docker Hub:
-
-```bash
-docker pull chainsafe/lodestar
-```
-
 ## Getting started
 
-- :gear: Follow the [installation guide](https://chainsafe.github.io/lodestar/installation) to install Lodestar.
-- :globe_with_meridians: Run lodestar on the [Ethereum beacon chain 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/).
+- :gear: Follow the installation method for [source install](https://chainsafe.github.io/lodestar/install/source.md), [NPM install](https://chainsafe.github.io/lodestar/install/npm.md), or [Docker install](https://chainsafe.github.io/lodestar/install/docker.md) to install Lodestar. Or use our [comprehensive setup guide](https://hackmd.io/@philknows/rk5cDvKmK).
+- :books: Use [Lodestar libraries](https://chainsafe.github.io/lodestar/libraries) in your next Ethereum Typescript project.
+- :globe_with_meridians: Run a beacon node on [mainnet or a public testnet](https://chainsafe.github.io/lodestar/usage/beacon-management.md).
+- :computer: Utilize 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).
+- :memo: Prospective contributors can read the [contributing section](./CONTRIBUTING.md) to understand how we develop and test on Lodestar.
 - :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)!
   [![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord&logo=discord)](https://discord.gg/aMxzVcr)
 - :rotating_light: Please note our [security policy](./SECURITY.md).

docs/index.md

@@ -6,18 +6,33 @@
 
 ### Getting started
 
-- Follow the [installation guide](installation) to install the Lodestar CLI.
-- Use [lodestar libraries](libraries) in your next Ethereum Typescript project.
-- Run a node on [mainnet or a public testnet](usage/testnet).
+- Follow the installation method for [source install](install/source.md), [NPM install](install/npm.md), or [Docker install](install/docker.md) to install Lodestar. Or use our [comprehensive setup guide](https://hackmd.io/@philknows/rk5cDvKmK).
+- Use [Lodestar libraries](libraries) in your next Ethereum Typescript project.
+- Run a beacon node on [mainnet or a public testnet](usage/beacon-management.md).
 - Utilize the whole stack by [starting a local testnet](usage/local).
-- View the lodestar [cli commands and options](https://chainsafe.github.io/lodestar/reference/cli/)
+- View the Lodestar [CLI commands and options](https://chainsafe.github.io/lodestar/reference/cli/)
 - View the [typedoc code docs](packages).
-- Prospective contributors can read the [contributing section](contributing) to understand how we develop and test on Lodestar.
+- Prospective contributors can read the [contributing section](https://chainsafe.github.io/lodestar/contributing/) to understand how we develop and test on Lodestar.
+- If you have questions [submit an issue](https://github.com/ChainSafe/lodestar/issues/new) or join us on [Discord](https://discord.gg/yjyvFRP)!
+- Please note our [security policy](https://github.com/ChainSafe/lodestar/blob/unstable/SECURITY.md).
+- Sign up to our [mailing list](https://chainsafe.typeform.com/lodestar) for announcements and any critical information about Lodestar.
 
-## About this docs
+## Specifications
+
+Hardware specifications minimum / recommended, to run the Lodestar client.
+
+|           | Minimum                          | Recommended                       |
+| --------- | -------------------------------- | --------------------------------- |
+| Processor | Intel Core i5–760 or AMD FX-8100 | Intel Core i7–4770 or AMD FX-8310 |
+| Memory    | 4GB RAM                          | 8GB RAM                           |
+| Storage   | 20GB available space SSD         | 100GB available space SSD         |
+| Internet  | Broadband connection             | Broadband connection              |
+
+
+## About these docs
 
 This documentation is open source, contribute at [github.com/chainsafe/lodestar/docs](https://github.com/ChainSafe/lodestar/tree/unstable/docs).
 
 ## Need assistance?
 
-If you have questions about this documentation, feel free to talk to us on our [discord](https://discord.gg/yjyvFRP) or [open an issue](https://github.com/ChainSafe/lodestar/issues/new/choose) and a member of the team or our community will be happy to assist you.
+If you have questions about this documentation, feel free to talk to us on our [ChainSafe Discord](https://discord.gg/yjyvFRP) or [open an issue](https://github.com/ChainSafe/lodestar/issues/new/choose) and a member of the team or our community will be happy to assist you.

docs/install/docker.md

@@ -0,0 +1,28 @@
+# Install with Docker
+
+The [`chainsafe/lodestar`](https://hub.docker.com/r/chainsafe/lodestar) Docker Hub repository is mantained actively. It contains the `lodestar` CLI preinstalled.
+
+<!-- prettier-ignore-start -->
+!!! info
+    The Docker Hub image tagged as `chainsafe/lodestar:next` is run on CI every dev commit on our `unstable` branch.
+    For `stable` releases, the image is tagged as `chainsafe/lodestar:latest`.
+<!-- prettier-ignore-end -->
+
+Ensure you have Docker installed by issuing the command:
+
+```bash
+docker -v
+```
+
+It should return a non error message such as `Docker version xxxx, build xxxx`.
+
+Pull, run the image and Lodestar should now be ready to use
+
+```bash
+docker pull chainsafe/lodestar
+docker run chainsafe/lodestar --help
+```
+<!-- prettier-ignore-start -->
+!!! info
+    Docker is the recommended setup for Lodestar. Use our [comprehensive setup guide](https://hackmd.io/@philknows/rk5cDvKmK) with Docker for detailed instructions.
+<!-- prettier-ignore-end -->

docs/install/npm.md

@@ -0,0 +1,6 @@
+# Install from NPM [not recommended]
+
+<!-- prettier-ignore-start -->
+!!! danger
+    For mainnet (production) usage, we only recommend installing with docker due to [NPM supply chain attacks](https://hackaday.com/2021/10/22/supply-chain-attack-npm-library-used-by-facebook-and-others-was-compromised/). Until a [safer installation method has been found](https://github.com/ChainSafe/lodestar/issues/3596), do not use this install method except for experimental purposes only.
+<!-- prettier-ignore-end -->

docs/install/source.md

@@ -0,0 +1,38 @@
+# Install from source
+
+Make sure to have [Yarn installed](https://classic.yarnpkg.com/en/docs/install). It is also recommended to [install NVM (Node Version Manager)](https://github.com/nvm-sh/nvm) and use v16 of [NodeJS](https://nodejs.org/en/).
+
+<!-- prettier-ignore-start -->
+!!! info
+    NodeJS versions < 16.x are not supported by Lodestar. We currently recommend running NodeJS 16.x.
+<!-- prettier-ignore-end -->
+
+Clone the repo locally.
+
+```bash
+git clone https://github.com/chainsafe/lodestar.git
+```
+
+Install across all packages. Lodestar follows a [monorepo](https://github.com/lerna/lerna) structure, so all commands below must be run in the project root. Use the `--ignore-optional` flag to prevent downloading the Ethereum Consensus spec tests.
+
+```bash
+yarn install --ignore-optional
+```
+
+Build across all packages.
+
+```bash
+yarn run build
+```
+
+Or if you are using [Lerna](https://lerna.js.org/):
+
+```bash
+lerna bootstrap
+```
+
+Lodestar should now be ready for use.
+
+```bash
+./lodestar --help
+```

docs/libraries/index.md

@@ -10,6 +10,7 @@ Several useful Ethereum consensus libraries are developed as part of the [Lodest
 - [types](https://github.com/ChainSafe/lodestar/tree/unstable/packages/types) - Ethereum consensus datatypes, Typescript interfaces and SSZ type objects
 - [config](https://github.com/ChainSafe/lodestar/tree/unstable/packages/config) - Ethereum consensus run-time network configuration
 - [api](https://github.com/ChainSafe/lodestar/tree/unstable/packages/api) - Ethereum consensus REST API client
+- [flare](https://github.com/ChainSafe/lodestar/tree/unstable/packages/flare) - Beacon chain multi-purpose and debugging tool
 
 ## Other libraries