status-im/nimbus-eth2
2
0
Fork 0
mirror of https://github.com/status-im/nimbus-eth2.git synced 2025-01-22 20:42:13 +00:00
Code Issues Projects Releases Wiki Activity

remove bundled pyrmont support (#3568)

Browse Source 
The `pyrmont` testnet has been discontinued.

For experiments, it's still possible to run pyrmont nodes by passing a
genesis/config, but this PR removes the bundled `--network:pyrmont`
option.

* update docs
* remove empty docs
* remove obsolete `eth2-stats` page
This commit is contained in:
Jacek Sieka 2022-04-05 14:59:25 +02:00 committed by GitHub
parent 759a793764
commit 6f4fa32c1d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 34 additions and 166 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Makefile
View File

@ -371,32 +371,6 @@ define CLEAN_NETWORK
rm -rf build/data/shared_$(1)*/*.log rm -rf build/data/shared_$(1)*/*.log
endef endef
###
### Pyrmont
###
pyrmont-build: | nimbus_beacon_node nimbus_signing_node
# https://www.gnu.org/software/make/manual/html_node/Call-Function.html#Call-Function
pyrmont: | pyrmont-build
$(call CONNECT_TO_NETWORK,pyrmont,nimbus_beacon_node,$(GOERLI_WEB3_URL))
pyrmont-vc: | pyrmont-build nimbus_validator_client
$(call CONNECT_TO_NETWORK_WITH_VALIDATOR_CLIENT,pyrmont,nimbus_beacon_node,$(GOERLI_WEB3_URL))
ifneq ($(LOG_LEVEL), TRACE)
pyrmont-dev:
+ "$(MAKE)" LOG_LEVEL=TRACE $@
else
pyrmont-dev: | pyrmont-build
$(call CONNECT_TO_NETWORK_IN_DEV_MODE,pyrmont,nimbus_beacon_node,$(GOERLI_WEB3_URL))
endif
pyrmont-dev-deposit: | pyrmont-build deposit_contract
$(call MAKE_DEPOSIT,pyrmont,$(GOERLI_WEB3_URL))
clean-pyrmont:
$(call CLEAN_NETWORK,pyrmont)
### ###
### Prater ### Prater
### ###

3
beacon_chain/networking/network_metadata.nim
View File

@ -219,7 +219,6 @@ when not defined(gnosisChainBinary):
when const_preset == "mainnet": when const_preset == "mainnet":
const const
mainnetMetadata* = eth2Network("shared/mainnet", mainnet) mainnetMetadata* = eth2Network("shared/mainnet", mainnet)
pyrmontMetadata* = eth2Network("shared/pyrmont", goerli)
praterMetadata* = eth2Network("shared/prater", goerli) praterMetadata* = eth2Network("shared/prater", goerli)
proc getMetadataForNetwork*(networkName: string): Eth2NetworkMetadata {.raises: [Defect, IOError].} = proc getMetadataForNetwork*(networkName: string): Eth2NetworkMetadata {.raises: [Defect, IOError].} =
@ -239,8 +238,6 @@ when not defined(gnosisChainBinary):
case toLowerAscii(networkName) case toLowerAscii(networkName)
of "mainnet": of "mainnet":
mainnetMetadata mainnetMetadata
of "pyrmont":
pyrmontMetadata
of "prater": of "prater":
praterMetadata praterMetadata
else: else:

34
docker/dist/README.md.tpl vendored
View File

@ -26,20 +26,23 @@ make dist
## Significant differences from self-built binaries ## Significant differences from self-built binaries
No `-march=native`. Binary builds are configured to maximise portability, disabling the use of
advanced CPU features which may result in lower performance on some hardware.
## Running a Pyrmont node ## Running a node
With default options: See https://nimbus.guide for full instructions on running a node.
To connect to mainnet with default options:
```bash ```bash
./run-pyrmont-beacon-node.sh ./run-mainnet-beacon-node.sh
``` ```
The script will forward all supplied options to the beacon node executable: The script will forward all supplied options to the beacon node executable:
```bash ```bash
./run-pyrmont-beacon-node.sh --log-level=DEBUG --tcp-port=9050 ./run-mainnet-beacon-node.sh --log-level=DEBUG --tcp-port=9050
``` ```
To monitor the Eth1 validator deposit contract, you'll need to pair To monitor the Eth1 validator deposit contract, you'll need to pair
@ -54,26 +57,15 @@ By default, the script will ask you to enter a web3 provider URL interactively,
but this can be bypassed by specifying a websocket `WEB3_URL` environment variable: but this can be bypassed by specifying a websocket `WEB3_URL` environment variable:
```bash ```bash
WEB3_URL="<YOUR_WEB3_URL>" ./run-pyrmont-beacon-node.sh # using a local mainnet instance
WEB3_URL="ws://localhost:8545" ./run-mainnet-beacon-node.sh
``` ```
## Running a mainnet node ## Testnet
`run-mainnet-beacon-node.sh` is a similar script intended for connecting to mainnet. The `prater` testnet runs on
All the same conventions apply:
```bash ```bash
# using a local Geth instance # using a local Goerli instance
WEB3_URL="ws://localhost:8545" ./run-mainnet-node.sh --max-peers=150 WEB3_URL="ws://localhost:8545" ./run-mainnet-node.sh --max-peers=150
``` ```
## Running a Prater node
`run-prater-beacon-node.sh` is a similar script intended for connecting to the Prater
testnet. All the same conventions apply:
```bash
# using a local Geth instance
WEB3_URL="ws://localhost:8545" ./run-prater-node.sh --max-peers=150
```

3
docs/the_nimbus_book/src/SUMMARY.md
View File

@ -62,7 +62,6 @@
- [Contribute](./contribute.md) - [Contribute](./contribute.md)
- [Resources](./resources.md) - [Resources](./resources.md)
- [Binary distribution internals](./distribution_internals.md) - [Binary distribution internals](./distribution_internals.md)
- [Prater: What you should know](./prater.md) - [Prater testnet](./prater.md)
- [Security Audit](./audit.md) - [Security Audit](./audit.md)
- [FAQ](./faq.md) - [FAQ](./faq.md)

1
docs/the_nimbus_book/src/beacon_node.md
View File

@ -1 +0,0 @@
# Run the beacon node

77
docs/the_nimbus_book/src/eth2-stats.md
View File

@ -1,77 +0,0 @@
# Network stats and monitoring
> ⚠️ This page concerns the [Pyrmont](https://pyrmont.launchpad.ethereum.org/) testnet. eth2stats is a debugging / developer tool that's suitable for testnets. For privacy reasons, we do not recommend using it for mainnet. For a mainnet alternative, see [this guide](./metrics-pretty-pictures.md).
eth2stats is a network monitoring suite for your beacon node + validator client.
It consists of a [command-line-interface](https://github.com/Alethio/eth2stats-client) (to help you query your node's API), and an [associated website](https://eth2stats.io/medalla-testnet) (which allows you to monitor your node from anywhere).
In this guide we'll take you through how to get eth2stats running on your local machine, and how to hook your node up to the website.
## Prerequisites
Knowledge of both [git](https://www.learnenough.com/git-tutorial/getting_started) and [command line basics](https://www.learnenough.com/command-line-tutorial/basics), and a working [Golang](https://golang.org/dl/) environment.
## Guide
### 1. Clone the eth2stats repository
```
git clone https://github.com/Alethio/eth2stats-client.git
```
### 2. Move into the repository
```
cd eth2stats-client
```
### 3. Build the executable
```
make build
```
### 4. Add your node
Go to [https://pyrmont.eth2.wtf/](https://pyrmont.eth2.wtf/)
#### 1. Click on add node
![](https://i.imgur.com/1ofuj4E.png)
#### 2. Configure name and client type
![](https://i.imgur.com/iQfwAit.png)
#### 3. Copy the command
Click on `Compile from source` and copy the command at the bottom.
![](https://i.imgur.com/biT5HkJ.png)
### 5. Build and run your node with metrics enabled
From your `nimbus-eth2` repository, run:
```
make nimbus_beacon_node
```
Followed by:
```
./run-pyrmont-beacon-node.sh --metrics
```
### 6. Run eth2stats
From your `eth2stats-client` repository, **run the command you copied in step 4.3:**
```
./eth2stats-client run \
--eth2stats.node-name="roger" \
--data.folder ~/.eth2stats/data \
--eth2stats.addr="grpc.pyrmont.eth2.wtf:8080" --eth2stats.tls=false \
--beacon.type="nimbus" \
--beacon.addr="http://localhost:9190" \
--beacon.metrics-addr="http://localhost:8008/metrics"
```
Your node should now be displayed on [https://pyrmont.eth2.wtf/](https://pyrmont.eth2.wtf/) :)

35
docs/the_nimbus_book/src/prater.md
View File

@ -1,29 +1,28 @@
# Prater testnet: what you should know # Prater testnet
</br> `prater` is a testnet that you can use to verify that your setup is ready for mainnet, as well as safely practise node operations such as adding and removing validators, migrating between clients and performing upgrades and backups.
</br>
The `prater` testnet is run by client teams, the Ethereum Foundation and community members.
- The Prater launchpad is live here (use it to make a deposit): [https://prater.launchpad.ethereum.org/en/](https://prater.launchpad.ethereum.org/en/) Connecting to `prater` and setting up a validator follows the same procedure as a normal mainnet node with the following modifications:
- To run a Prater node after making a deposit, [update Nimbus](./keep-updated.md) and then execute `./run-prater-beacon-node.sh` * Validator deposits are done on the `goerli` testnet via the [Prater launchpad](https://prater.launchpad.ethereum.org/en/)
* To run a Prater node after making a deposit, [update Nimbus](./keep-updated.md) and then execute `./run-prater-beacon-node.sh` or use the `--network:prater` command line option.
</br> ## Custom testnets
</br>
----------------------------------------------------------
</br>
</br>
The latest Eth2 testnet, [Prater](https://twitter.com/Butta_eth/status/1374383003011452937), is open to the public.
Prater's objective is to ensure that the network remains stable under a higher load than we've seen so far on mainnet -- the genesis count for Prater was 210k (almost double the size of the Beacon Chain Mainnet).
To elaborate a little, we want to make sure that the network is able to function properly with considerably more validators: increasing the number of validators increases the state size, increases the amount of work done to process that state, and increases the number of messages being gossipped on the network; blocks also become fuller, which explores a new kind of constraint as clients need to optimise better for attestation inclusion.
You can connect to any network provided that you have a configuration and genesis file, using the `network` option:
```
build/nimbus_beacon_node --network:path/to/network --data-dir:path/to/data
```
The network directory must have the same layout as the [eth2-networks](https://github.com/eth-clients/eth2-networks) repository testnets.
## Other testnets
Historical testnets can be found [here](https://github.com/eth-clients/eth2-networks).
* `pyrmont` - deprecated in favour of `prater` due to its small validator count compared to `mainnet`
* `insecura` - a spin-off of `prater` to demonstrate the [weak subjectivity attack](https://ethresear.ch/t/insecura-my-consensus-for-the-pyrmont-network)
* `medalla` - one of the first multi-client testnets, deprecated in favour of `pyrmont` to capture the latest 1.0 spec changes

4
docs/the_nimbus_book/src/resources.md
View File

@ -2,9 +2,9 @@
- [ethstaker discord](https://discord.com/invite/e84CFep): great place for tips and discussions - [ethstaker discord](https://discord.com/invite/e84CFep): great place for tips and discussions
- [Validator launchpad](https://prater.launchpad.ethereum.org): to send Prater deposits - [Validator launchpad](https://launchpad.ethereum.org): to send deposits
- [Beacon chain explorer](https://pyrmont.beaconcha.in/) : to monitor testnet health - [Beacon chain explorer](https://beaconcha.in/) : to monitor network health
- [Nimbus discord](https://discord.com/invite/XRxWahP) : best place to ask questions and to stay up-to-date with critical updates - [Nimbus discord](https://discord.com/invite/XRxWahP) : best place to ask questions and to stay up-to-date with critical updates

1
docs/the_nimbus_book/src/rp-overview.md
View File

@ -1 +0,0 @@
# Overview

1
docs/the_nimbus_book/src/rp-pi-guide.md
View File

@ -1 +0,0 @@
# Pi users

2
docs/the_nimbus_book/src/rp-quick-start.md
View File

@ -129,7 +129,7 @@ Request **35** Goerli ETH from [the faucet](https://faucet.goerli.mudit.blog/) t
## 10. Request Goerli RPL ## 10. Request Goerli RPL
You'll also need some RPL. To request RPL directly from the Rocket Pool faucet, run: You'll also need some RPL. To request RPL directly from the Rocket Pool faucet, run:
``` ```
rocketpool faucet withdraw-rpl rocketpool faucet withdraw-rpl

13
run-pyrmont-beacon-node.sh
View File

@ -1,13 +0,0 @@
#!/usr/bin/env bash
# Copyright (c) 2020-2021 Status Research & Development GmbH. Licensed under
# either of:
# - Apache License, version 2.0
# - MIT license
# at your option. This file may not be copied, modified, or distributed except
# according to those terms.
cd "$(dirname $0)"
# Allow the binary to receive signals directly.
exec scripts/run-beacon-node.sh nimbus_beacon_node pyrmont $@