From b37cb63d95efdb69446ea610c28eb853480f968e Mon Sep 17 00:00:00 2001 From: sacha Date: Tue, 21 Sep 2021 13:56:55 +0200 Subject: [PATCH 1/2] Begin messaging overhaul (#118) * Website update (#104) * Remove technical material from eth2 section + minor edits (#97) * Update team.yml * Update Nimbus docs * add newsletter to header, footer, and mobile * remove eth2-temp * add mamy's feedback * add donation address * fix github link, add page on fluffy * edit contribute message * Update fluffy.md (#112) Remove some outdated resources and small clean-up * try and fix fluffy 404 * try and fix fluffy 404 * try and fix fluffy 404 * try and fix fluffy 404 * try and fix fluffy 404 * try and fix fluffy 404 * try and fix fluffy 404 * update homepage (#115) * homepage edits * cp * update docs home Co-authored-by: Kim De Mey --- source/docs/index.md | 38 +++++++++++++---------------------- themes/navy/layout/index.swig | 8 ++++---- 2 files changed, 18 insertions(+), 28 deletions(-) diff --git a/source/docs/index.md b/source/docs/index.md index 1c0dc68..8f8dd19 100644 --- a/source/docs/index.md +++ b/source/docs/index.md @@ -1,41 +1,31 @@ -title: An Ethereum 2.0 Sharding Client +title: A lighter Ethereum Client --- ## Overview -Nimbus is a client implementation for both Ethereum 2.0 and Ethereum 1.0 that strives to be as lightweight as possible in terms of resources used. This allows it to perform well on embedded systems, embedded devices -- including Raspberry Pis and mobile devices. +Nimbus is a client implementation for both Ethereum's consensus layer (Ethereum 2) and execution layer (Ethereum 1) that strives to be as lightweight as possible in terms of resources used. This allows it to perform well on embedded systems, embedded devices -- including Raspberry Pis and mobile devices. -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). - -Nimbus' embeddable, lightweight, and self-contained design makes it production ready for Web 3.0 and ensures that it can be supported and maintained across all goals of Ethereum 2.0. - -For a more comprehensive introduction, please read our [Nimbus for Newbies](https://our.status.im/nimbus-for-newbies/) post. +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). -## Requirements +## Programming language -[Nim](https://nim-lang.org/) is an efficient, general-purpose systems programming language with a Python-like syntax that compiles to C. Nim will allow us to implement Ethereum rapidly and take advantage of the mature C-language tooling: in compilation of machine code, and in the analysis of static code. +[Nim](https://nim-lang.org/) is an efficient, general-purpose systems programming language with a Python-like syntax that compiles to C. Nim allows us to implement Ethereum rapidly and take advantage of the mature C-language tooling: in compilation of machine code, and in the analysis of static code. -With Ethereum research currently modeled in Python, the end result of implementing in Nim should be code that: +The end result of implementing in Nim is code that: 1. Enables us to easily bring research into production -1. Has a high degree of reasonability for researchers -1. Is performant in production +2. Has a high degree of reasonability for researchers +3. Is performant in production -The core contributors and Nim community have been very supportive and enthusiastic for the project. +Both the Nim core contributors and the wider Nim community have been very supportive of this choice. -## Development on Embedded Systems - -We believe that the largest successful deployment of Ethereum will reside on embedded systems: IoT devices and mobile personal devices, such as smartphones. Although Nimbus will support full and archival nodes, its main implementation will be as a light client, with focus on Proof of Stake and sharding. - -Existing implementations of Ethereum have focused on desktop computers and servers. These implementations have played a major role in the initial success of Ethereum, and they are suitable for full and archival nodes. However, their deployment on embedded systems has been an afterthought. - -During the deployment of Status among 40,000 alpha testers, we found that a significant portion (23.6%) of users were still running old mobile devices. In addition, recently discovered [Spectre vulnerabilities](https://en.wikipedia.org/wiki/Spectre_(security_vulnerability)) have led to an increase in the demand for open processors. For these reasons, we propose a self-imposed constraint and a requirement that Status perform well on the following: +## Light by design -1. 2014 [SoC](https://en.wikipedia.org/wiki/System_on_a_chip) architectures, such as the [Cortex-A53](https://developer.arm.com/products/processors/cortex-a/cortex-a53) (Samsung Note 4 & [Raspberry Pi 3](https://www.raspberrypi.org/products/raspberry-pi-3-model-b/)) and the Apple A8 (iPhone 6) -1. [MIPS](https://en.wikipedia.org/wiki/MIPS_architecture)-based architectures, such as the [Onion Omega2](https://onion.io/omega2/) -1. Open-source processors, such as [RISC-V](https://riscv.org) +Existing implementations of Ethereum have focused on desktop computers and servers. These implementations have played a major role in the initial success of Ethereum, however, their deployment on resource-restricted systems has been an afterthought. -When the 2020 scalability goal is fully realised, this constraint will help ensure that Ethereum runs performantly on resource-restricted hardware that is at least 6 years old. +We believe the ability to run a node on resource-restricted hardware is key to a safe and secure Ethereum going forward. + +As such, **Nimbus strives to perform just as well on resource-restricted hardware as it does on desktop computers and servers.** diff --git a/themes/navy/layout/index.swig b/themes/navy/layout/index.swig index c8fbbdb..78fc09d 100644 --- a/themes/navy/layout/index.swig +++ b/themes/navy/layout/index.swig @@ -11,9 +11,9 @@
-

The lightest Ethereum client

+

We build lighter Ethereum clients

-Nimbus is a client implementation for both Ethereum 2.0 and Ethereum 1.0 that strives to be as lightweight as possible in terms of resources used. This allows it to perform well on embedded systems, resource-restricted devices -- including Raspberry Pis and mobile devices -- and multi-purpose servers. +Nimbus is a client implementation for both Ethereum 1 and Ethereum 2 that strives to be as lightweight as possible in terms of resources used. This allows it to perform well on embedded systems, resource-restricted devices -- including Raspberry Pis and mobile devices -- and multi-purpose servers.

See our docs @@ -24,14 +24,14 @@ Nimbus is a client implementation for both Ethereum 2.0 and Ethereum 1.0 that st

Consensus layer(eth2)

You can use Nimbus today to both monitor the eth2 chain and join the network as a fully-fledged validator.

- See our book + See our guide

Execution layer (eth1)

-

We are working hard on a mainnet-capable Ethereum 1 client to complement our Ethereum 2 client. +

We are working hard on a lightweight Ethereum 1 client to complement our Ethereum 2 client.

Keep up with our progress
From b2eaa620065f50abfe7dd47ccc8b239dd873db67 Mon Sep 17 00:00:00 2001 From: sacha Date: Tue, 21 Sep 2021 14:13:40 +0200 Subject: [PATCH 2/2] Start docs overhaul (#119) * Website update (#104) * Remove technical material from eth2 section + minor edits (#97) * Update team.yml * Update Nimbus docs * add newsletter to header, footer, and mobile * remove eth2-temp * add mamy's feedback * add donation address * fix github link, add page on fluffy * edit contribute message * Update fluffy.md (#112) Remove some outdated resources and small clean-up * try and fix fluffy 404 * try and fix fluffy 404 * try and fix fluffy 404 * try and fix fluffy 404 * try and fix fluffy 404 * try and fix fluffy 404 * try and fix fluffy 404 * update homepage (#115) * homepage edits * cp * update docs home * doc updates Co-authored-by: Kim De Mey --- source/docs/eth1.md | 10 +++++----- source/docs/eth2.md | 11 ++--------- themes/navy/languages/en.yml | 4 ++-- themes/navy/layout/index.swig | 2 +- 4 files changed, 10 insertions(+), 17 deletions(-) diff --git a/source/docs/eth1.md b/source/docs/eth1.md index 30fdf0c..c422c01 100644 --- a/source/docs/eth1.md +++ b/source/docs/eth1.md @@ -1,13 +1,13 @@ --- id: eth1 -title: Connecting to the eth1 chain +title: Execution layer client (eth1) --- -While our core focus so far has been Ethereum 2.0, going forward we will be devoting significantly more resources to our Ethereum 1.0 client. As it stands, however, this software is very much experimental. +While our core focus so far has been Ethereum 2, we are now devoting significant resources to our Ethereum 1 client. ## Quickstart -To run Nimbus in [Ethereum 1.0 mode](https://github.com/status-im/nimbus-eth1), first [install the prerequisites](https://github.com/status-im/nimbus-eth1#prerequisites). +To run Nimbus in [Ethereum 1 mode](https://github.com/status-im/nimbus-eth1), first [install the prerequisites](https://github.com/status-im/nimbus-eth1#prerequisites). Then run the following commands: @@ -24,6 +24,6 @@ make nimbus ./build/nimbus ``` -> **Note:** We currently do not guarantee that Nimbus will work on Windows. +Nimbus will now run and attempt to synchronize with the Ethereum 1 blockchain. -Nimbus will now run and attempt to synchronize with the Ethereum 1.0 blockchain. +For a more complete overview see the [repository README](https://github.com/status-im/nimbus-eth1). diff --git a/source/docs/eth2.md b/source/docs/eth2.md index a567258..f0405e2 100644 --- a/source/docs/eth2.md +++ b/source/docs/eth2.md @@ -1,21 +1,14 @@ --- id: eth2 -title: Connecting to the eth2 chain +title: Consensus layer client (eth2) --- -Depending on your objective, there are various ways to run Nimbus in [Ethereum 2.0 mode](https://github.com/status-im/nimbus-eth2). +Depending on your objective, there are various ways to run Nimbus in [Ethereum 2 mode](https://github.com/status-im/nimbus-eth2). The reference documentation is [the Nimbus Book](https://nimbus.guide): it explains all the ways in which you can play with Nimbus, and use Nimbus to either monitor the eth2 chain or become a fully-fledged validator. We encourage you to check it out here: https://nimbus.guide -## Prater testnet - -The latest Eth2 testnet, [Prater](https://twitter.com/Butta_eth/status/1374383003011452937), is now 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). - -For more, see the [Prater page](https://nimbus.guide/prater.html) of the Nimbus guide. diff --git a/themes/navy/languages/en.yml b/themes/navy/languages/en.yml index 0f1a80a..484a468 100644 --- a/themes/navy/languages/en.yml +++ b/themes/navy/languages/en.yml @@ -21,8 +21,8 @@ sidebar: docs: Nimbus: Nimbus introduction: What Is Nimbus? - eth1: eth1 client - eth2: eth2 client + eth1: Execution layer (eth1) client + eth2: Consensus layer (eth2) client fluffy: Fluffy libraries: Software Libraries milestones: Milestones diff --git a/themes/navy/layout/index.swig b/themes/navy/layout/index.swig index 78fc09d..8e01d09 100644 --- a/themes/navy/layout/index.swig +++ b/themes/navy/layout/index.swig @@ -21,7 +21,7 @@ Nimbus is a client implementation for both Ethereum 1 and Ethereum 2 that strive
-

Consensus layer(eth2)

+

Consensus layer (eth2)

You can use Nimbus today to both monitor the eth2 chain and join the network as a fully-fledged validator.

See our guide