switch docs/ nim-beacon-chain references to nimbus-eth2 (#1842)
This commit is contained in:
tersec
GitHub
parent
c0aa2f1e58
commit
1d5352aa5d
|
|
@ -46,10 +46,10 @@ We are currently adding fuzzing to our repositories via libFuzzer and AFL.
|
|||
Sigma Prima is fuzzing all Ethereum 2 clients on the spec (Eth2 core/Validator core)
|
||||
|
||||
We provide them with a simple C API
|
||||
- [https://github.com/status-im/nim-beacon-chain/blob/4a2e1806/nfuzz/libnfuzz.h](https://github.com/status-im/nim-beacon-chain/blob/4a2e1806/nfuzz/libnfuzz.h)
|
||||
- [https://github.com/status-im/nimbus-eth2/blob/4a2e1806/nfuzz/libnfuzz.h](https://github.com/status-im/nimbus-eth2/blob/4a2e1806/nfuzz/libnfuzz.h)
|
||||
|
||||
That we implement:
|
||||
- [https://github.com/status-im/nim-beacon-chain/blob/4a2e1806/nfuzz/libnfuzz.nim](https://github.com/status-im/nim-beacon-chain/blob/4a2e1806/nfuzz/libnfuzz.nim)
|
||||
- [https://github.com/status-im/nimbus-eth2/blob/4a2e1806/nfuzz/libnfuzz.nim](https://github.com/status-im/nimbus-eth2/blob/4a2e1806/nfuzz/libnfuzz.nim)
|
||||
|
||||
And compile the nim code as a shared or static library.
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
### NBC repo
|
||||
|
||||
`nim-beacon-chain` uses a build system based on makefiles.
|
||||
`nimbus-eth2` uses a build system based on makefiles.
|
||||
Usage is described in the README.
|
||||
|
||||
In particular a `env.sh` scripts is provided that setups the environment variable
|
||||
|
|
@ -30,7 +30,7 @@ are also setting up a Nim environment from scratch.
|
|||
|
||||
### NBC repo
|
||||
|
||||
For the `nim-beacon-chain` application, all dependencies are vendored
|
||||
For the `nimbus-eth2` application, all dependencies are vendored
|
||||
in the `vendor` folder.
|
||||
|
||||
With regards to the audit scope we have the following dependencies:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Nimbus Beacon Chain
|
||||
|
||||
[https://github.com/status-im/nim-beacon-chain](https://github.com/status-im/nim-beacon-chain)
|
||||
[https://github.com/status-im/nimbus-eth2](https://github.com/status-im/nimbus-eth2)
|
||||
|
||||
Nimbus Beacon Chain (NBC) is an implementation of an Ethereum 2 client.
|
||||
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ installation directory to "C:\mingw-w64" and add it to your system PATH in "My
|
|||
Computer"/"This PC" -> Properties -> Advanced system settings -> Environment
|
||||
Variables -> Path -> Edit -> New -> C:\mingw-w64\mingw64\bin (it's "C:\mingw-w64\mingw32\bin" on 32-bit)
|
||||
|
||||
Install [Git for Windows](https://gitforwindows.org/) and use a "Git Bash" shell to clone and build nim-beacon-chain.
|
||||
Install [Git for Windows](https://gitforwindows.org/) and use a "Git Bash" shell to clone and build nimbus-eth2.
|
||||
|
||||
If you don't want to compile PCRE separately, you can fetch pre-compiled DLLs with:
|
||||
|
||||
|
|
@ -135,7 +135,7 @@ make NIMFLAGS="-d:release"
|
|||
make -j$(nproc) NIMFLAGS="-d:release" USE_MULTITAIL=yes eth2_network_simulation
|
||||
```
|
||||
|
||||
- don't use the [lightweight stack tracing implementation from nim-libbacktrace](https://github.com/status-im/nim-beacon-chain/pull/745):
|
||||
- don't use the [lightweight stack tracing implementation from nim-libbacktrace](https://github.com/status-im/nimbus-eth2/pull/745):
|
||||
|
||||
```bash
|
||||
make USE_LIBBACKTRACE=0 # expect the resulting binaries to be 2-3 times slower
|
||||
|
|
|
|||
|
|
@ -15,8 +15,8 @@ To build the beacon run:
|
|||
#### 1. Clone the nim beacon chain repository
|
||||
|
||||
```
|
||||
git clone https://github.com/status-im/nim-beacon-chain
|
||||
cd nim-beacon-chain
|
||||
git clone https://github.com/status-im/nimbus-eth2
|
||||
cd nimbus-eth2
|
||||
```
|
||||
|
||||
#### 2. Run the beacon node build process
|
||||
|
|
|
|||
|
|
@ -9,10 +9,10 @@ NBC's [external dependencies](./install.md#external-dependencies) and a working
|
|||
|
||||
### 1. Clone repositories
|
||||
|
||||
Clone the [nim-beacon-chain](https://github.com/status-im/nim-beacon-chain) and [eth2stats](https://github.com/Alethio/eth2stats-client) repositories in the same directory (so that both repositories are adjacent to each other).
|
||||
Clone the [nimbus-eth2](https://github.com/status-im/nimbus-eth2) and [eth2stats](https://github.com/Alethio/eth2stats-client) repositories in the same directory (so that both repositories are adjacent to each other).
|
||||
|
||||
```console
|
||||
git clone https://github.com/status-im/nim-beacon-chain.git
|
||||
git clone https://github.com/status-im/nimbus-eth2.git
|
||||
git clone https://github.com/Alethio/eth2stats-client.git
|
||||
```
|
||||
|
||||
|
|
@ -20,9 +20,9 @@ git clone https://github.com/Alethio/eth2stats-client.git
|
|||
|
||||
Build both repositories by following their respective build instructions.
|
||||
|
||||
*nim-beacon-chain*
|
||||
*nimbus-eth2*
|
||||
```console
|
||||
cd nim-beacon-chain
|
||||
cd nimbus-eth2
|
||||
make beacon_node
|
||||
```
|
||||
|
||||
|
|
@ -33,7 +33,7 @@ cd eth2stats-client
|
|||
make build
|
||||
```
|
||||
|
||||
The resulting binaries should appear in `nim-beacon-chain/build/beacon_node` and `eth2stats-client/eth2stats-client`, respectively.
|
||||
The resulting binaries should appear in `nimbus-eth2/build/beacon_node` and `eth2stats-client/eth2stats-client`, respectively.
|
||||
|
||||
### 3. Create an executable script
|
||||
|
||||
|
|
@ -47,7 +47,7 @@ set +e
|
|||
trap "trap - SIGTERM && kill -- -$$" SIGINT SIGTERM EXIT
|
||||
|
||||
cd $(dirname "$0")
|
||||
cd nim-beacon-chain
|
||||
cd nimbus-eth2
|
||||
|
||||
NETWORK=$1
|
||||
NODE_NAME=${NODE_NAME:-$(whoami)}
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ We use an utility tool called mdBook to create online books from Markdown files.
|
|||
## Before You Start
|
||||
|
||||
1. Install mdBook from [here](https://github.com/rust-lang/mdBook).
|
||||
2. Clone the repository by `git clone https://github.com/status-im/nim-beacon-chain.git`.
|
||||
2. Clone the repository by `git clone https://github.com/status-im/nimbus-eth2.git`.
|
||||
3. Go to where the Markdown files are located by `cd docs`.
|
||||
|
||||
## Real-Time Update and Preview Changes
|
||||
|
|
@ -17,10 +17,10 @@ We use an utility tool called mdBook to create online books from Markdown files.
|
|||
|
||||
## Build and Deploy
|
||||
|
||||
The first step is to submit a pull request to the [devel branch](https://github.com/status-im/nim-beacon-chain/tree/devel).
|
||||
The first step is to submit a pull request to the [devel branch](https://github.com/status-im/nimbus-eth2/tree/devel).
|
||||
Then, after it is merged, do the following under our main repository:
|
||||
|
||||
1. `cd nim-beacon-chain`
|
||||
1. `cd nimbus-eth2`
|
||||
2. `git checkout devel`
|
||||
3. `git pull`
|
||||
4. `make update` (This is to update the submodules to the latest version)
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ You need to have installed Nimbus' [external dependencies](./install.md#external
|
|||
|
||||
## 1. Create a wallet
|
||||
|
||||
Run the following command from the the home directory of the `nim-beacon-chain` repository to launch the command line interface app:
|
||||
Run the following command from the the home directory of the `nimbus-eth2` repository to launch the command line interface app:
|
||||
|
||||
```
|
||||
build/beacon_node wallets create
|
||||
|
|
@ -152,7 +152,7 @@ The following options are available:
|
|||
|
||||
<img src="https://storage.googleapis.com/ethereum-hackmd/upload_6db4e4c3715a0a80db53bd5f26eb1ffc.png" width="500">
|
||||
|
||||
*Remember you can find your `deposit_data` JSON file in the `nim-beacon-chain/validators` directory*
|
||||
*Remember you can find your `deposit_data` JSON file in the `nimbus-eth2/validators` directory*
|
||||
|
||||
</br>
|
||||
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ To get around this problem, we recommend launching the beacon node with your own
|
|||
|
||||
|
||||
|
||||
> **Note:** In a previous version of the software it wasn't possible to manually override the web3 endpoint when running `make zinken` or `make medalla`. For the instructions below to work, make sure you've updated to the latest version of the software (run `git pull && make update` from the `master` branch of the `nim-beacon-chain` repository).
|
||||
> **Note:** In a previous version of the software it wasn't possible to manually override the web3 endpoint when running `make zinken` or `make medalla`. For the instructions below to work, make sure you've updated to the latest version of the software (run `git pull && make update` from the `master` branch of the `nimbus-eth2` repository).
|
||||
|
||||
### 1. Visit Infura.io
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
The Nimbus beacon chain is a research implementation of the Beacon Chain – the core system level chain at the heart of Ethereum 2.0.
|
||||
|
||||
|
||||
- Open sourced at [github.com/status-im/nim-beacon-chain](https://github.com/status-im/nim-beacon-chain/tree/master)
|
||||
- Open sourced at [github.com/status-im/nimbus-eth2](https://github.com/status-im/nimbus-eth2/tree/master)
|
||||
|
||||
- Specification described at [ethereum/eth2.0-specs](https://github.com/ethereum/eth2.0-specs/tree/v0.12.3#phase-0)
|
||||
|
||||
|
|
@ -73,7 +73,7 @@ Need help with anything? Join us on [Status](https://join.status.im/nimbus-gener
|
|||
|
||||
## Disclaimer
|
||||
|
||||
This documentation assumes Nimbus is in its ideal state. The project is still under active development. Please submit a [Github issue](https://github.com/status-im/nim-beacon-chain/issues) if you come across a problem.
|
||||
This documentation assumes Nimbus is in its ideal state. The project is still under active development. Please submit a [Github issue](https://github.com/status-im/nimbus-eth2/issues) if you come across a problem.
|
||||
|
||||
<!-- > > > TODO:
|
||||
|
||||
|
|
|
|||
|
|
@ -2,12 +2,12 @@
|
|||
|
||||
As it stands, we are continuously making improvements to both stability and memory usage. So please make sure you keep your client up to date! This means restarting your node and updating your software regularly from the `master` branch. If you can't find a solution to your problem here, feel free to hit us up on our [discord](https://discord.com/invite/XRxWahP)!
|
||||
|
||||
> **Note:** While the `master` branch of the `nim-beacon-chain` repository is more stable, the latest updates happen in the `devel` branch which is (usually) merged into master every week on Tuesday. If you choose to run Nimbus directly from the `devel` branch, be prepared for instabilities!
|
||||
> **Note:** While the `master` branch of the `nimbus-eth2` repository is more stable, the latest updates happen in the `devel` branch which is (usually) merged into master every week on Tuesday. If you choose to run Nimbus directly from the `devel` branch, be prepared for instabilities!
|
||||
|
||||
To update and restart, run `git pull`, `make update`, followed by `make medalla`:
|
||||
|
||||
```
|
||||
cd nim-beacon-chain
|
||||
cd nimbus-eth2
|
||||
git pull
|
||||
make update # Update dependencies
|
||||
make medalla # Restart using same keys as last run
|
||||
|
|
@ -59,7 +59,7 @@ make NODE_PARAMS="--nat:\"extip:35.124.65.104\"" medalla
|
|||
|
||||
### Resource leaks
|
||||
|
||||
If you're experiencing RAM related resource leaks, try restarting your client (**we recommend restarting every 6 hours** until we get to the bottom of this issue). If you have a [local Grafana setup](https://github.com/status-im/nim-beacon-chain#getting-metrics-from-a-local-testnet-client), you can try monitoring the severity of these leaks and playing around with the restart interval.
|
||||
If you're experiencing RAM related resource leaks, try restarting your client (**we recommend restarting every 6 hours** until we get to the bottom of this issue). If you have a [local Grafana setup](https://github.com/status-im/nimbus-eth2#getting-metrics-from-a-local-testnet-client), you can try monitoring the severity of these leaks and playing around with the restart interval.
|
||||
|
||||
### Address already in use error
|
||||
|
||||
|
|
|
|||
|
|
@ -22,8 +22,8 @@ To start validating on the `medalla` network:
|
|||
#### 1. Clone the nim beacon chain repository
|
||||
|
||||
```
|
||||
git clone https://github.com/status-im/nim-beacon-chain
|
||||
cd nim-beacon-chain
|
||||
git clone https://github.com/status-im/nimbus-eth2
|
||||
cd nimbus-eth2
|
||||
```
|
||||
|
||||
#### 2. Build the beacon node
|
||||
|
|
@ -205,7 +205,7 @@ make NODE_PARAMS="--tcp-port=9100 --udp-port=9100" medalla
|
|||
|
||||
>**Note:** the above command has exactly the same effect as `make BASE_PORT=9100 medalla`
|
||||
|
||||
A complete list of the available parameters can be found [here](https://github.com/status-im/nim-beacon-chain/blob/devel/beacon_chain/conf.nim#L92-L210) (use a parameter's `name` field to set it).
|
||||
A complete list of the available parameters can be found [here](https://github.com/status-im/nimbus-eth2/blob/devel/beacon_chain/conf.nim#L92-L210) (use a parameter's `name` field to set it).
|
||||
|
||||
### Logs
|
||||
|
||||
|
|
@ -214,8 +214,8 @@ Log files are saved in `build/data/shared_medalla_0/`.
|
|||
|
||||
### Makefile
|
||||
|
||||
If you are comfortable reading [Makefiles](https://en.wikipedia.org/wiki/Makefile#:~:text=A%20makefile%20is%20a%20file,to%20generate%20a%20target%2Fgoal), you can see the commands that `make medalla` executes under the hood, [here](https://github.com/status-im/nim-beacon-chain/blob/23bec993414df904e9d7ea9d26e65005b981aee0/Makefile#L184-L197).
|
||||
If you are comfortable reading [Makefiles](https://en.wikipedia.org/wiki/Makefile#:~:text=A%20makefile%20is%20a%20file,to%20generate%20a%20target%2Fgoal), you can see the commands that `make medalla` executes under the hood, [here](https://github.com/status-im/nimbus-eth2/blob/23bec993414df904e9d7ea9d26e65005b981aee0/Makefile#L184-L197).
|
||||
|
||||
Some of the provided options (such as `--network=medalla`) are essential while others (such as the ones controlling logging, metrics, ports, and the RPC service) are there for convenience.
|
||||
|
||||
The Goerli testnet parameters (`$(GOERLI_TESTNETS_PARAMS`), are defined higher up in the Makefile, [here](https://github.com/status-im/nim-beacon-chain/blob/23bec993414df904e9d7ea9d26e65005b981aee0/Makefile#L164-L171).
|
||||
The Goerli testnet parameters (`$(GOERLI_TESTNETS_PARAMS`), are defined higher up in the Makefile, [here](https://github.com/status-im/nimbus-eth2/blob/23bec993414df904e9d7ea9d26e65005b981aee0/Makefile#L164-L171).
|
||||
|
|
|
|||
|
|
@ -71,7 +71,7 @@ cp prometheus-2.20.1.linux-amd64/prometheus /usr/local/bin/
|
|||
|
||||
Prometheus relies on a YAML configuration file to let it know where, and how often, to scrape data.
|
||||
|
||||
`nim-beacon-chain` generates an appropriate configuration file (`prometheseus.yml`) when you build the beacon node. If you're running the `medalla` testnet you'll find this in `build/data/shared_medalla_0`.
|
||||
`nimbus-eth2` generates an appropriate configuration file (`prometheseus.yml`) when you build the beacon node. If you're running the `medalla` testnet you'll find this in `build/data/shared_medalla_0`.
|
||||
|
||||
To run Prometheus with the default config file:
|
||||
|
||||
|
|
@ -138,11 +138,11 @@ Click on `Upload JSON file`
|
|||
|
||||
|
||||
|
||||
Select the `beacon_nodes_Grafana_dashboard.json` from the `nim-beacon-chain/grafana/` folder and click on `Import`
|
||||
Select the `beacon_nodes_Grafana_dashboard.json` from the `nimbus-eth2/grafana/` folder and click on `Import`
|
||||
|
||||
|
||||
|
||||
You'll be directed to the dashboard where you'll be able to gain insights into the performance of `nim-beacon-chain` and your validators
|
||||
You'll be directed to the dashboard where you'll be able to gain insights into the performance of `nimbus-eth2` and your validators
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -31,8 +31,8 @@ Before we start, we have to obtain 32 ETH on the Goerli testnet (later on, we'll
|
|||
- **_Remember to replace `make` with `mingw32-make` if using Windows._**
|
||||
|
||||
```bash
|
||||
git clone https://github.com/status-im/nim-beacon-chain
|
||||
cd nim-beacon-chain
|
||||
git clone https://github.com/status-im/nimbus-eth2
|
||||
cd nimbus-eth2
|
||||
git checkout devel
|
||||
git pull
|
||||
make update
|
||||
|
|
|
|||
|
|
@ -38,14 +38,14 @@ This tutorial assumes basic knowledge of the [command line](https://www.learneno
|
|||
|
||||
To import your `zinken` key(s) into Nimbus:
|
||||
|
||||
> **Note:** You can skip steps 1 and 2 below if you've already cloned `nim-beacon-chain` and built the beacon node for `medalla`: just make sure you run `git pull && make update` from the `master` branch before continuing with step 3.
|
||||
> **Note:** You can skip steps 1 and 2 below if you've already cloned `nimbus-eth2` and built the beacon node for `medalla`: just make sure you run `git pull && make update` from the `master` branch before continuing with step 3.
|
||||
|
||||
|
||||
#### 1. Clone the nim beacon chain repository
|
||||
|
||||
```
|
||||
git clone https://github.com/status-im/nim-beacon-chain
|
||||
cd nim-beacon-chain
|
||||
git clone https://github.com/status-im/nimbus-eth2
|
||||
cd nimbus-eth2
|
||||
```
|
||||
|
||||
#### 2. Build the beacon node
|
||||
|
|
@ -177,7 +177,7 @@ NOT 2020-10-07 17:04:09.231+02:00 Starting beacon node top
|
|||
|
||||
>**Note:** the above command has exactly the same effect as `make BASE_PORT=9100 zinken`
|
||||
|
||||
A complete list of the available parameters can be found [here](https://github.com/status-im/nim-beacon-chain/blob/devel/beacon_chain/conf.nim#L92-L210) (use a parameter's `name` field to set it).
|
||||
A complete list of the available parameters can be found [here](https://github.com/status-im/nimbus-eth2/blob/devel/beacon_chain/conf.nim#L92-L210) (use a parameter's `name` field to set it).
|
||||
|
||||
### Logs
|
||||
|
||||
|
|
@ -186,11 +186,11 @@ NOT 2020-10-07 17:04:09.231+02:00 Starting beacon node top
|
|||
|
||||
### Makefile
|
||||
|
||||
If you are comfortable reading [Makefiles](https://en.wikipedia.org/wiki/Makefile#:~:text=A%20makefile%20is%20a%20file,to%20generate%20a%20target%2Fgoal), you can see the commands that `make zinken` executes under the hood, [here](https://github.com/status-im/nim-beacon-chain/blob/23bec993414df904e9d7ea9d26e65005b981aee0/Makefile#L184-L197).
|
||||
If you are comfortable reading [Makefiles](https://en.wikipedia.org/wiki/Makefile#:~:text=A%20makefile%20is%20a%20file,to%20generate%20a%20target%2Fgoal), you can see the commands that `make zinken` executes under the hood, [here](https://github.com/status-im/nimbus-eth2/blob/23bec993414df904e9d7ea9d26e65005b981aee0/Makefile#L184-L197).
|
||||
|
||||
Some of the provided options (such as `--network`) are essential while others (such as the ones controlling logging, metrics, ports, and the RPC service) are optional and included for the sake convenience.
|
||||
|
||||
The Goerli testnet parameters (`$(GOERLI_TESTNETS_PARAMS`), are defined higher up in the Makefile, [here](https://github.com/status-im/nim-beacon-chain/blob/23bec993414df904e9d7ea9d26e65005b981aee0/Makefile#L164-L171).
|
||||
The Goerli testnet parameters (`$(GOERLI_TESTNETS_PARAMS`), are defined higher up in the Makefile, [here](https://github.com/status-im/nimbus-eth2/blob/23bec993414df904e9d7ea9d26e65005b981aee0/Makefile#L164-L171).
|
||||
|
||||
## Useful Resources
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue