Nimbus guide simplifications (#2516)

* update nimbus book readme

* Revert "update nimbus book readme"

This reverts commit d568f0f7a3.

* simplify web3 provider instructions

* add donation address
This commit is contained in:
Sacha Saint-Leger 2021-04-22 13:12:24 +02:00 committed by GitHub
parent bbb8866c09
commit 7e31798649
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 23 additions and 37 deletions

View File

@ -18,18 +18,17 @@
- [Install dependencies](./install.md)
- [Build the beacon node](./build.md)
- [Run an eth1 node](./eth1.md)
- [Add a backup web3 provider](./web3-backup.md)
- [Sync the beacon node](./start-syncing.md)
- [Make a deposit for your validator](./deposit.md)
- [Import your validator keys](./keys.md)
- [Connect your validator to eth2](./connect-eth2.md)
- [Keep an eye on your validator](./keep-an-eye.md)
- [Keep Nimbus updated](./keep-updated.md)
- [Mainnet preparations](./preparation.md)
- [Email notifications](./email-notifications.md)
- [Prepare for mainnet](./preparation.md)
- [Set up email notifications](./email-notifications.md)
- [Graffiti the blockchain](./graffiti.md)
- [Download binaries](./binaries.md)
- [Docker images](./docker.md)
- [Download Docker images](./docker.md)
- [Troubleshoot](./troubleshooting.md)
- [Recover / generate keys](./more-keys.md)
- [Perform a voluntary exit](./voluntary-exit.md)
@ -37,6 +36,7 @@
- [Set up log rotation](./log-rotate.md)
- [Verify the integrity of Nimbus](./checksums.md)
- [Back up your database](./database-backup.md)
- [Add a backup web3 provider](./web3-backup.md)
# Tutorials
- [Grafana and Prometheus](./metrics-pretty-pictures.md)

View File

@ -6,8 +6,12 @@ Nimbus is a client implementation for both Ethereum 2.0 and Ethereum 1.0 that st
However, resource-restricted hardware is not the only thing Nimbus is good for. Its low resource consumption makes it easy to run Nimbus together with other workloads on your server (this is especially valuable for stakers looking to lower the cost of their server instances).
</br>
<blockquote class="twitter-tweet"><p lang="en" dir="ltr">&quot;just because it [Nimbus] is optimized to be minimally resource intensive, doesn&#39;t mean you can&#39;t run it on a server. It means that when you do run it on a server, it is consuming a lot less resources.&quot; <a href="https://t.co/F2sdZouBtD">https://t.co/F2sdZouBtD</a></p>&mdash; Nimbus (@ethnimbus) <a href="https://twitter.com/ethnimbus/status/1376836270245154817?ref_src=twsrc%5Etfw">March 30, 2021</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
</br>
This book explains the ways in which you can use Nimbus to either monitor the eth2 chain or become a fully-fledged validator.
> **N.B.** The reality is that we are very early in the eth2 validating life cycle. Validating is not for everyone yet, and it comes with both risks and responsibilities. It isn't a particularly easy way to make money. You'll need to put effort into updating your software, researching hard-forks, having a robust setup... . As such, you should only stake if you are genuinely interested in securing the protocol.
@ -38,8 +42,12 @@ In contrast to the Ethereum chain, as it currently stands, eth2 uses proof-of-st
Need help with anything? Join us on [Status](https://join.status.im/nimbus-general) and [Discord](https://discord.gg/9dWwPnG).
### Donate
If you'd like to contribute to Nimbus development, our donation address is [`0x70E47C843E0F6ab0991A3189c28F2957eb6d3842`](https://etherscan.io/address/0x70E47C843E0F6ab0991A3189c28F2957eb6d3842)
### Stay updated
Subscribe to our newsletter [here](https://subscribe.nimbus.team/).
Subscribe to our newsletter [here](https://subscribe.nimbus.guide/).
### Disclaimer

View File

@ -370,7 +370,7 @@ https://status-im.github.io/nimbus-eth2/eth1.html
Please enter a Web3 provider URL:
```
Enter your own secure websocket (`wss`) [Infura endpoint](./infura-guide.md).
Enter your own secure websocket (`wss`) [endpoint](eth1.md).
### 19. Check for successful connection

View File

@ -1,4 +1,4 @@
# Mainnet preparations
# Prepare for Mainnet
## Latest software

View File

@ -15,38 +15,18 @@ To start syncing the `pyrmont` testnet , from the `nimbus-eth2` repository, run:
### Mainnet
> **Note:** Mainnet won't launch before December 1st.
To start monitoring the eth1 mainnet chain for deposits, from the `nimbus-eth2` repository, run:
To start syncing the eth2 mainnet, while monitoring the eth1 mainnet chain for deposits, run:
```
./run-mainnet-beacon-node.sh
./run-mainnet-beacon-node.sh --web3-url="ws://127.0.0.1:8546"
```
### Web3 provider URL
You should see the following prompt:
Note, the above command assumes you are running a [local geth instance](./eth1.md). Geth accepts connections from the loopback interface (`127.0.0.1`), with default WebSocket port `8546`. This means that your default Web3 provider URL should be: `ws://127.0.0.1:8546`
```
To monitor the Eth1 validator deposit contract, you'll need to pair
the Nimbus beacon node with a Web3 provider capable of serving Eth1
event logs. This could be a locally running Eth1 client such as Geth
or a cloud service such as Infura. For more information please see
our setup guide:
>**N.B.** If you're using [your own Infura endpoint](./infura-guide), you should enter that instead.
https://status-im.github.io/nimbus-eth2/eth1.html
Please enter a Web3 provider URL:
```
If you're running a local geth instance, geth accepts connections from the loopback interface (`127.0.0.1`), with default WebSocket port `8546`. This means that your default Web3 provider URL should be:
```
ws://127.0.0.1:8546
```
>**Note:** If you're using [your own Infura endpoint](./infura-guide), you should enter that instead.
Once you've entered your Web3 provider URL, you should see the following output:
You should see the following output:
```
INF 2020-12-01 11:25:33.487+01:00 Launching beacon node

View File

@ -8,5 +8,3 @@ For example, if your primary eth1 node is a [local Geth](./eth1.md), but you wan
./run-mainnet-beacon-node.sh --web3-url="ws://127.0.0.1:8546" --web3-url="wss://mainnet.infura.io/ws/v3/..."
```
> **Note:** that as it stands, when you run this command, you'll be prompted once again for a web3url again -- **please enter your primary one**. This is a UX bug and [we've pushed a fix](https://github.com/status-im/nimbus-eth2/pull/2501) that will be integrated into our next release.