From 7c5e6c63b17b205b32dd198ead9c9fb068fc717c Mon Sep 17 00:00:00 2001 From: Sacha Saint-Leger Date: Wed, 27 Jan 2021 13:50:23 +0100 Subject: [PATCH 01/11] Remove technical material from eth2 section + minor edits (#97) --- source/docs/contributor_guide.md | 4 -- source/docs/eth1.md | 4 +- source/docs/eth2-temp.md | 95 ++++++++++++++++++++++++++++++++ source/docs/eth2.md | 87 +---------------------------- 4 files changed, 100 insertions(+), 90 deletions(-) create mode 100644 source/docs/eth2-temp.md diff --git a/source/docs/contributor_guide.md b/source/docs/contributor_guide.md index 5ecbbe2..156091b 100644 --- a/source/docs/contributor_guide.md +++ b/source/docs/contributor_guide.md @@ -37,10 +37,6 @@ make update If you have research ideas you'd like to throw at us, exotic hardware you'd like to test on, or anything else revolutionary cooking up in your mind let us know. We'll gladly experiment! -## Testing - -You can join a testnet by following instructions [here](https://status-im.github.io/nimbus-eth2/). - ## Guidelines Whatever you might expect to see in other projects applies here: diff --git a/source/docs/eth1.md b/source/docs/eth1.md index f093cf1..30fdf0c 100644 --- a/source/docs/eth1.md +++ b/source/docs/eth1.md @@ -3,7 +3,9 @@ id: eth1 title: Connecting to the eth1 chain --- -While our core focus right now is Ethereum 2.0, We are continuing to make progress on an Ethereum 1.0 client (take note, this software is very much experimental). +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. + +## 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). diff --git a/source/docs/eth2-temp.md b/source/docs/eth2-temp.md new file mode 100644 index 0000000..845e2ae --- /dev/null +++ b/source/docs/eth2-temp.md @@ -0,0 +1,95 @@ +--- +id: eth2 +title: Connecting to the eth2 chain +--- + +Depending on your objective, there are various ways to run Nimbus in [Ethereum 2.0 mode](https://github.com/status-im/nimbus-eth2). + +Here is where we push our code: 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. + +It's hosted here: https://nimbus.guide + +## Build and run the Ethereum 2.0 local beacon chain simulation + +The beacon chain simulation runs several beacon nodes on the local machine, attaches several local validators to each, and builds a beacon chain between them. + +**Prerequisites:** At the moment, Nimbus has to be built from source, and has the following external dependencies -- developer tools (C compiler, Make, Bash, Git), [PCRE](https://www.pcre.org/); follow the instructions outlined [here](https://github.com/status-im/nim-beacon-chain#prerequisites-for-everyone) to install them. + +Once you've installed the prerequisites, you're ready to enter the Ethereum 2.0 realm of Nimbus: + +```bash +git clone https://github.com/status-im/nim-beacon-chain +cd nim-beacon-chain + +make +make test +``` + +To run the simulation: + +```bash +make eth2_network_simulation +``` + +If you'd like to clean the previous run's data: + +```bash +make clean_eth2_network_simulation_all +``` + +To change the number of validators and nodes: + +```bash +# Clear data files from your last run and start the simulation with a new genesis block: +make VALIDATORS=192 NODES=6 USER_NODES=1 eth2_network_simulation +``` + +If you’d like to see the nodes running on separated sub-terminals inside one big window, install [Multitail](https://www.vanheusden.com/multitail/index.php) (if you're on a Mac, follow the instructions [here](https://brewinstall.org/Install-multitail-on-Mac-with-Brew/)), then: + + +``` +USE_MULTITAIL="yes" make eth2_network_simulation +``` + +You’ll get something like this (click for full size): + +[![](https://i.imgur.com/Pc99VDO.png)](https://i.imgur.com/Pc99VDO.png) + + +You can find out more about the beacon node simulation [here](https://our.status.im/nimbus-development-update-03/#beaconsimulation). + +## Build and run the Ethereum 2.0 local state transition simulation + +This simulation is primarily designed for researchers, but we'll cover it briefly here in case you're curious :) + +The [state transition](https://github.com/ethereum/annotated-spec/blob/master/phase0/beacon-chain.md#beacon-chain-state-transition-function) simulation quickly runs the beacon chain state transition function in isolation and outputs JSON snapshots of the state (directly to the `nim-beacon-chain` directory). It runs without networking and blocks are processed without slot time delays. + +```bash +# build the state simulator, then display its help ("-d:release" speeds it +# up substantially, allowing the simulation of longer runs in reasonable time) +make NIMFLAGS="-d:release" state_sim +build/state_sim --help +``` + +Use the output of the `help` command to pass desired values to the simulator - experiment with changing the number of slots, validators, , etc. to get different results. + +The most important options are: + +- `slots` : the number of slots to run the simulation for (default 192) +- `validators`: the number of validators (default 6400) +- `attesterRatio`: the expected fraction of attesters that actually do their work for every slot (default 0.73) +- `json_interval`: how often JSON snapshots of the state are outputted (default every 32 slots -- or once per epoch) + +For example, to run the state simulator for 384 slots, with 20,000 validators, and an average of 66% of attesters doing their work every slot, while outputting snapshots of the state twice per epoch, run: + +``` +build/state_sim --slots=384 --validators=20000 --attesterRatio=0.66 --json_interval=16 +``` + + +## Medalla Ethereum 2.0 Testnet + +There is a publicly available [Ethereum 2.0](https://our.status.im/tag/two-point-oh) multi-client testnet currently running. Read all about it [here](https://blog.ethereum.org/2020/08/03/eth2-quick-update-no-14/), and learn how you can join it in [the Nimbus beacon chain book](https://status-im.github.io/nimbus-eth2/medalla.html) 💛 + diff --git a/source/docs/eth2.md b/source/docs/eth2.md index 9796c97..9b8a5c8 100644 --- a/source/docs/eth2.md +++ b/source/docs/eth2.md @@ -5,91 +5,8 @@ title: Connecting to the eth2 chain Depending on your objective, there are various ways to run Nimbus in [Ethereum 2.0 mode](https://github.com/status-im/nimbus-eth2). -## Become an eth2 validator +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're writing a book that explains all the ways in which you can use Nimbus to either monitor the eth2 chain or become a fully-fledged validator. - -It's hosted here: https://status-im.github.io/nimbus-eth2/ - -## Build and run the Ethereum 2.0 local beacon chain simulation - -The beacon chain simulation runs several beacon nodes on the local machine, attaches several local validators to each, and builds a beacon chain between them. - -**Prerequisites:** At the moment, Nimbus has to be built from source, and has the following external dependencies -- developer tools (C compiler, Make, Bash, Git), [PCRE](https://www.pcre.org/); follow the instructions outlined [here](https://github.com/status-im/nim-beacon-chain#prerequisites-for-everyone) to install them. - -Once you've installed the prerequisites, you're ready to enter the Ethereum 2.0 realm of Nimbus: - -```bash -git clone https://github.com/status-im/nim-beacon-chain -cd nim-beacon-chain - -make -make test -``` - -To run the simulation: - -```bash -make eth2_network_simulation -``` - -If you'd like to clean the previous run's data: - -```bash -make clean_eth2_network_simulation_all -``` - -To change the number of validators and nodes: - -```bash -# Clear data files from your last run and start the simulation with a new genesis block: -make VALIDATORS=192 NODES=6 USER_NODES=1 eth2_network_simulation -``` - -If you’d like to see the nodes running on separated sub-terminals inside one big window, install [Multitail](https://www.vanheusden.com/multitail/index.php) (if you're on a Mac, follow the instructions [here](https://brewinstall.org/Install-multitail-on-Mac-with-Brew/)), then: +We encourage you to check it out here: https://nimbus.guide -``` -USE_MULTITAIL="yes" make eth2_network_simulation -``` - -You’ll get something like this (click for full size): - -[![](https://i.imgur.com/Pc99VDO.png)](https://i.imgur.com/Pc99VDO.png) - - -You can find out more about the beacon node simulation [here](https://our.status.im/nimbus-development-update-03/#beaconsimulation). - -## Build and run the Ethereum 2.0 local state transition simulation - -This simulation is primarily designed for researchers, but we'll cover it briefly here in case you're curious :) - -The [state transition](https://github.com/ethereum/annotated-spec/blob/master/phase0/beacon-chain.md#beacon-chain-state-transition-function) simulation quickly runs the beacon chain state transition function in isolation and outputs JSON snapshots of the state (directly to the `nim-beacon-chain` directory). It runs without networking and blocks are processed without slot time delays. - -```bash -# build the state simulator, then display its help ("-d:release" speeds it -# up substantially, allowing the simulation of longer runs in reasonable time) -make NIMFLAGS="-d:release" state_sim -build/state_sim --help -``` - -Use the output of the `help` command to pass desired values to the simulator - experiment with changing the number of slots, validators, , etc. to get different results. - -The most important options are: - -- `slots` : the number of slots to run the simulation for (default 192) -- `validators`: the number of validators (default 6400) -- `attesterRatio`: the expected fraction of attesters that actually do their work for every slot (default 0.73) -- `json_interval`: how often JSON snapshots of the state are outputted (default every 32 slots -- or once per epoch) - -For example, to run the state simulator for 384 slots, with 20,000 validators, and an average of 66% of attesters doing their work every slot, while outputting snapshots of the state twice per epoch, run: - -``` -build/state_sim --slots=384 --validators=20000 --attesterRatio=0.66 --json_interval=16 -``` - - -## Medalla Ethereum 2.0 Testnet - -There is a publicly available [Ethereum 2.0](https://our.status.im/tag/two-point-oh) multi-client testnet currently running. Read all about it [here](https://blog.ethereum.org/2020/08/03/eth2-quick-update-no-14/), and learn how you can join it in [the Nimbus beacon chain book](https://status-im.github.io/nimbus-eth2/medalla.html) 💛 - From 16994baec17c8846ce85de8aed65432f75a2cc30 Mon Sep 17 00:00:00 2001 From: Sacha Saint-Leger Date: Tue, 16 Mar 2021 23:30:25 +0100 Subject: [PATCH 02/11] Update team.yml --- source/_data/team.yml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/source/_data/team.yml b/source/_data/team.yml index 006bcf4..bf92ded 100644 --- a/source/_data/team.yml +++ b/source/_data/team.yml @@ -53,12 +53,6 @@ statusName: "Cylindrical Darling Mastiff" githubLink: "https://github.com/sinkingsugar" -- name: "Viktor Kirilov" - image: "/img/viktor.jpg" - statusLink: "https://join.status.im/user/0x0427fdc3290d711c35c747c282e90737ac05970917ef6cf65cd4b568b7d843103a57f676371bf734ccb82c310d5e1bea33ee236261d3f990d814b29c2ffe342ca7" - statusName: "Nimble Powerful Vaquita" - gitHubLink: "https://github.com/onqtam" - - name: "Dmitriy Ryajov" image: "/img/dryajov.jpg" statusLink: "https://join.status.im/user/0x041bee40a44bdd2b0a5cc00a45e3626414194b05ea911c7169b9bcdfa0f8453566212ef982e4b5f9379796e28d9c8befbed26ec6ae2293ab7fcd90656db3d20e51" From 4f0e5e12990cba1f521e15ec488b923414aeb193 Mon Sep 17 00:00:00 2001 From: yslcrypto Date: Wed, 7 Apr 2021 11:23:32 +0200 Subject: [PATCH 03/11] Update Nimbus docs --- source/docs/index.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/source/docs/index.md b/source/docs/index.md index 5791d85..9a50127 100644 --- a/source/docs/index.md +++ b/source/docs/index.md @@ -3,11 +3,9 @@ title: An Ethereum 2.0 Sharding Client ## Overview -Nimbus is a project founded by the [Status.im](https://status.im/) network, focused on providing the best Ethereum experience for resource-restricted devices. +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. -Because the largest deployment of Ethereum will potentially be on embedded systems, Nimbus is designed to perform well on IoT and personal mobile devices, including older smartphones with resource-restricted hardware. - -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 eth2 stakers looking to lower the cost of their server instances). +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. From 215d36ecf286214d427c9c528caeb91757518b11 Mon Sep 17 00:00:00 2001 From: yslcrypto Date: Wed, 7 Apr 2021 11:28:58 +0200 Subject: [PATCH 04/11] add newsletter to header, footer, and mobile --- themes/navy/layout/partial/footer.swig | 1 + themes/navy/layout/partial/header-nav.swig | 1 + themes/navy/layout/partial/header.swig | 1 + 3 files changed, 3 insertions(+) diff --git a/themes/navy/layout/partial/footer.swig b/themes/navy/layout/partial/footer.swig index 456a061..716610a 100644 --- a/themes/navy/layout/partial/footer.swig +++ b/themes/navy/layout/partial/footer.swig @@ -19,6 +19,7 @@
  • Docs
  • Github
  • News
    • +
  • Newsletter
  • Donate
  • Privacy Policy
    • diff --git a/themes/navy/layout/partial/header-nav.swig b/themes/navy/layout/partial/header-nav.swig index 3ace15a..ee84e55 100644 --- a/themes/navy/layout/partial/header-nav.swig +++ b/themes/navy/layout/partial/header-nav.swig @@ -4,4 +4,5 @@
  • Team
  • Docs
  • News
    • +
  • Newsletter
    • diff --git a/themes/navy/layout/partial/header.swig b/themes/navy/layout/partial/header.swig index 1c64b1c..1ebffdb 100644 --- a/themes/navy/layout/partial/header.swig +++ b/themes/navy/layout/partial/header.swig @@ -19,6 +19,7 @@
    • News
      • +
    • Newsletter
    • Docs
    • Projects From 5691c3661aac5b1a784b3809d84c39c2089f9524 Mon Sep 17 00:00:00 2001 From: yslcrypto Date: Wed, 7 Apr 2021 11:31:40 +0200 Subject: [PATCH 05/11] remove eth2-temp --- source/docs/eth2-temp.md | 95 ---------------------------------------- 1 file changed, 95 deletions(-) delete mode 100644 source/docs/eth2-temp.md diff --git a/source/docs/eth2-temp.md b/source/docs/eth2-temp.md deleted file mode 100644 index 845e2ae..0000000 --- a/source/docs/eth2-temp.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -id: eth2 -title: Connecting to the eth2 chain ---- - -Depending on your objective, there are various ways to run Nimbus in [Ethereum 2.0 mode](https://github.com/status-im/nimbus-eth2). - -Here is where we push our code: 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. - -It's hosted here: https://nimbus.guide - -## Build and run the Ethereum 2.0 local beacon chain simulation - -The beacon chain simulation runs several beacon nodes on the local machine, attaches several local validators to each, and builds a beacon chain between them. - -**Prerequisites:** At the moment, Nimbus has to be built from source, and has the following external dependencies -- developer tools (C compiler, Make, Bash, Git), [PCRE](https://www.pcre.org/); follow the instructions outlined [here](https://github.com/status-im/nim-beacon-chain#prerequisites-for-everyone) to install them. - -Once you've installed the prerequisites, you're ready to enter the Ethereum 2.0 realm of Nimbus: - -```bash -git clone https://github.com/status-im/nim-beacon-chain -cd nim-beacon-chain - -make -make test -``` - -To run the simulation: - -```bash -make eth2_network_simulation -``` - -If you'd like to clean the previous run's data: - -```bash -make clean_eth2_network_simulation_all -``` - -To change the number of validators and nodes: - -```bash -# Clear data files from your last run and start the simulation with a new genesis block: -make VALIDATORS=192 NODES=6 USER_NODES=1 eth2_network_simulation -``` - -If you’d like to see the nodes running on separated sub-terminals inside one big window, install [Multitail](https://www.vanheusden.com/multitail/index.php) (if you're on a Mac, follow the instructions [here](https://brewinstall.org/Install-multitail-on-Mac-with-Brew/)), then: - - -``` -USE_MULTITAIL="yes" make eth2_network_simulation -``` - -You’ll get something like this (click for full size): - -[![](https://i.imgur.com/Pc99VDO.png)](https://i.imgur.com/Pc99VDO.png) - - -You can find out more about the beacon node simulation [here](https://our.status.im/nimbus-development-update-03/#beaconsimulation). - -## Build and run the Ethereum 2.0 local state transition simulation - -This simulation is primarily designed for researchers, but we'll cover it briefly here in case you're curious :) - -The [state transition](https://github.com/ethereum/annotated-spec/blob/master/phase0/beacon-chain.md#beacon-chain-state-transition-function) simulation quickly runs the beacon chain state transition function in isolation and outputs JSON snapshots of the state (directly to the `nim-beacon-chain` directory). It runs without networking and blocks are processed without slot time delays. - -```bash -# build the state simulator, then display its help ("-d:release" speeds it -# up substantially, allowing the simulation of longer runs in reasonable time) -make NIMFLAGS="-d:release" state_sim -build/state_sim --help -``` - -Use the output of the `help` command to pass desired values to the simulator - experiment with changing the number of slots, validators, , etc. to get different results. - -The most important options are: - -- `slots` : the number of slots to run the simulation for (default 192) -- `validators`: the number of validators (default 6400) -- `attesterRatio`: the expected fraction of attesters that actually do their work for every slot (default 0.73) -- `json_interval`: how often JSON snapshots of the state are outputted (default every 32 slots -- or once per epoch) - -For example, to run the state simulator for 384 slots, with 20,000 validators, and an average of 66% of attesters doing their work every slot, while outputting snapshots of the state twice per epoch, run: - -``` -build/state_sim --slots=384 --validators=20000 --attesterRatio=0.66 --json_interval=16 -``` - - -## Medalla Ethereum 2.0 Testnet - -There is a publicly available [Ethereum 2.0](https://our.status.im/tag/two-point-oh) multi-client testnet currently running. Read all about it [here](https://blog.ethereum.org/2020/08/03/eth2-quick-update-no-14/), and learn how you can join it in [the Nimbus beacon chain book](https://status-im.github.io/nimbus-eth2/medalla.html) 💛 - From 326dac789644a0fde0a9ae48a5a25462149699f1 Mon Sep 17 00:00:00 2001 From: yslcrypto Date: Thu, 22 Apr 2021 16:18:54 +0200 Subject: [PATCH 06/11] add mamy's feedback --- source/docs/eth2.md | 7 +++++++ source/docs/index.md | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/source/docs/eth2.md b/source/docs/eth2.md index 9b8a5c8..2413f93 100644 --- a/source/docs/eth2.md +++ b/source/docs/eth2.md @@ -9,4 +9,11 @@ The reference documentation is [the Nimbus Book](https://nimbus.guide): it expla 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/source/docs/index.md b/source/docs/index.md index 9a50127..1c0dc68 100644 --- a/source/docs/index.md +++ b/source/docs/index.md @@ -3,7 +3,7 @@ title: An Ethereum 2.0 Sharding 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, resource-restricted devices -- including Raspberry Pis and mobile devices. +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. 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). From e19e7e50dd0eba66647198e7d3fc4c70edb1bc7d Mon Sep 17 00:00:00 2001 From: yslcrypto Date: Thu, 22 Apr 2021 16:41:53 +0200 Subject: [PATCH 07/11] add donation address --- themes/navy/layout/index.swig | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/themes/navy/layout/index.swig b/themes/navy/layout/index.swig index 00a7814..fcfb0a2 100644 --- a/themes/navy/layout/index.swig +++ b/themes/navy/layout/index.swig @@ -69,10 +69,10 @@ Nimbus is a client implementation for both Ethereum 2.0 and Ethereum 1.0 that st
      -

      Support us on Gitcoin

      -

      As an open source project largely dependent on the Ethereum Foundation for funding, grants are our lifeblood. +

      Suppport

      +

      As an open source project largely dependent on the Ethereum Foundation for funding, grants are our lifeblood. See here for our donation address.

      - Support us + Support us on Gitcoin

      From d028e624931675374af9f4897cbf68f6b2d2eeb3 Mon Sep 17 00:00:00 2001 From: 0xmiel Date: Wed, 14 Jul 2021 11:12:06 +0200 Subject: [PATCH 09/11] Add page on fluffy + fix github link (#110) * 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 --- source/_data/sidebar.yml | 1 + source/docs/fluffy.md | 29 ++++++++++++++++++++++++++ source/docs/libraries.md | 3 +++ themes/navy/languages/en.yml | 1 + themes/navy/layout/index.swig | 2 +- themes/navy/layout/partial/footer.swig | 2 +- 6 files changed, 36 insertions(+), 2 deletions(-) create mode 100644 source/docs/fluffy.md diff --git a/source/_data/sidebar.yml b/source/_data/sidebar.yml index b218e61..6200623 100644 --- a/source/_data/sidebar.yml +++ b/source/_data/sidebar.yml @@ -4,6 +4,7 @@ docs: design: /docs/design.html eth1: /docs/eth1.html eth2: /docs/eth2.html + fluffy: /docs/fluffy.html libraries: /docs/libraries.html contributor_guide: /docs/contributor_guide.html # Guides: diff --git a/source/docs/fluffy.md b/source/docs/fluffy.md new file mode 100644 index 0000000..6b545e5 --- /dev/null +++ b/source/docs/fluffy.md @@ -0,0 +1,29 @@ +--- +id: fluffy +title: Fluffy: an ultra-light client for Ethereum +--- + +Nimbus has joined the Ethereum Foundation’s Portal Network team as one of the launch clients for the portal network. + +In a sentence, [the Portal Network](https://github.com/ethereum/stateless-ethereum-specs/blob/master/portal-network.md#network-functionality) is an in-progress cross-team effort to re-imagine the ethereum light client, and develop a practical and functional light client experience. + +In particular, our aim is to work together with the EF to develop a new set of Ethereum protocols alongside the existing Eth protocol that will specifically serve this new way of accessing Ethereum data. + +The overarching goal is to provide a mode of operation for Ethereum that serves common usage patterns, as opposed to keeping track of the full state at all times, as current clients do. + +What we are talking about building here is the perfect client for a wallet. An ultra-light client that contributes to the network and does not require syncing (i.e. is immediately usable from a fresh install or after being offline). + +As such, one of the end goals for us is to embed this sort of client directly inside the Status app. + +This has the potential to both improve the security and privacy of our users (we will no longer have any reliance on Infura), as well as improve Ethereum’s resilience by allowing each user to contribute back to the health of the network. + +## Resources + +- [Our introductory post](https://our.status.im/nimbus-fluffly/) +- The Nimbus Light Portal Network client (nlpn) can be found in our nimbus-eth1 repository: https://github.com/status-im/nimbus-eth1/tree/master/fluffy +- The Portal Wire protocol is added to the nim-eth repository, as Node Discovery v5.1 sub-protocol: https://github.com/status-im/nim-eth +- Specifications: https://github.com/ethereum/stateless-ethereum-specs/ +- Website: https://www.ethportal.net/ +- Some quick notes regarding first Portal Wire interop tests with ddht and trin- https://gist.github.com/kdeme/36795f5deae7d02ce1785e9c7d501e53 +- [The winding road to functional light clients](https://snakecharmers.ethereum.org/the-winding-road-to-functional-light-clients/) blog post series of Piper Merriam +- [This video talk](https://www.youtube.com/watch?v=MZxqRs_tLNs) about the subject. diff --git a/source/docs/libraries.md b/source/docs/libraries.md index a4701df..3294b71 100644 --- a/source/docs/libraries.md +++ b/source/docs/libraries.md @@ -36,4 +36,7 @@ In addition to our [eth1](https://github.com/status-im/nimbus-eth1) and [eth2](h - Documentation Generator - language agnostic (but Nim-preconfigured) generator for beautiful detailed documentation suites for sets of libraries: https://github.com/status-im/nimbus-docs-suite +- Nim presto - an efficient library for REST API implementation: https://github.com/status-im/nim-presto + + We hope you take the time to check them out :) diff --git a/themes/navy/languages/en.yml b/themes/navy/languages/en.yml index 0e20db8..3ee98d8 100644 --- a/themes/navy/languages/en.yml +++ b/themes/navy/languages/en.yml @@ -23,6 +23,7 @@ sidebar: introduction: What Is Nimbus? eth1: eth1 client eth2: eth2 client + fluffy: Fluffy (Light Portal Network client) libraries: Software Libraries milestones: Milestones design: Design diff --git a/themes/navy/layout/index.swig b/themes/navy/layout/index.swig index bec3c2c..17586ae 100644 --- a/themes/navy/layout/index.swig +++ b/themes/navy/layout/index.swig @@ -71,7 +71,7 @@ Nimbus is a client implementation for both Ethereum 2.0 and Ethereum 1.0 that st

      Suppport

      -

      As an open source project largely dependent on the Ethereum Foundation for funding, grants are our lifeblood. See here for our donation address. +

      As an Ethereum public good, largely dependent on both Status and the Ethereum Foundation for funding, grants are our lifeblood. See here for our donation address

      Support us on Gitcoin diff --git a/themes/navy/layout/partial/footer.swig b/themes/navy/layout/partial/footer.swig index 716610a..a1caa4b 100644 --- a/themes/navy/layout/partial/footer.swig +++ b/themes/navy/layout/partial/footer.swig @@ -17,7 +17,7 @@

      More

      • Docs
        • -
      • Github
        • +
      • Github
      • News
      • Newsletter
      • Donate
        • From 54857df00e75228b6f4a82421ea6b8a099370e8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Soko=C5=82owski?= Date: Mon, 30 Aug 2021 20:17:25 +0200 Subject: [PATCH 10/11] update privacy policy link MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jakub Sokołowski --- themes/navy/layout/partial/footer.swig | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/themes/navy/layout/partial/footer.swig b/themes/navy/layout/partial/footer.swig index a1caa4b..da5d14d 100644 --- a/themes/navy/layout/partial/footer.swig +++ b/themes/navy/layout/partial/footer.swig @@ -21,7 +21,7 @@
      • News
      • Newsletter
      • Donate
        • -
      • Privacy Policy
        • +
      • Privacy Policy
      From e440ea2a8b0da0915d744374409e555e4f77ebf0 Mon Sep 17 00:00:00 2001 From: Kim De Mey Date: Mon, 13 Sep 2021 21:43:47 +0200 Subject: [PATCH 11/11] Update fluffy.md (#112) Remove some outdated resources and small clean-up --- source/docs/fluffy.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/source/docs/fluffy.md b/source/docs/fluffy.md index 6b545e5..ba3b706 100644 --- a/source/docs/fluffy.md +++ b/source/docs/fluffy.md @@ -3,9 +3,9 @@ id: fluffy title: Fluffy: an ultra-light client for Ethereum --- -Nimbus has joined the Ethereum Foundation’s Portal Network team as one of the launch clients for the portal network. +Nimbus has joined the Ethereum Foundation’s Portal Network team as one of the launch clients for the Portal Network. -In a sentence, [the Portal Network](https://github.com/ethereum/stateless-ethereum-specs/blob/master/portal-network.md#network-functionality) is an in-progress cross-team effort to re-imagine the ethereum light client, and develop a practical and functional light client experience. +In a sentence, [the Portal Network](https://github.com/ethereum/stateless-ethereum-specs/blob/master/portal-network.md#network-functionality) is an in-progress cross-team effort to re-imagine the Ethereum light client, and develop a practical and functional light client experience. In particular, our aim is to work together with the EF to develop a new set of Ethereum protocols alongside the existing Eth protocol that will specifically serve this new way of accessing Ethereum data. @@ -20,10 +20,8 @@ This has the potential to both improve the security and privacy of our users (we ## Resources - [Our introductory post](https://our.status.im/nimbus-fluffly/) -- The Nimbus Light Portal Network client (nlpn) can be found in our nimbus-eth1 repository: https://github.com/status-im/nimbus-eth1/tree/master/fluffy -- The Portal Wire protocol is added to the nim-eth repository, as Node Discovery v5.1 sub-protocol: https://github.com/status-im/nim-eth -- Specifications: https://github.com/ethereum/stateless-ethereum-specs/ -- Website: https://www.ethportal.net/ -- Some quick notes regarding first Portal Wire interop tests with ddht and trin- https://gist.github.com/kdeme/36795f5deae7d02ce1785e9c7d501e53 +- Fluffy, our Portal Network client can be found in our nimbus-eth1 repository: https://github.com/status-im/nimbus-eth1/tree/master/fluffy +- Portal Network specifications: https://github.com/ethereum/stateless-ethereum-specs/blob/master/portal-network.md +- Portal Network website: https://www.ethportal.net/ - [The winding road to functional light clients](https://snakecharmers.ethereum.org/the-winding-road-to-functional-light-clients/) blog post series of Piper Merriam - [This video talk](https://www.youtube.com/watch?v=MZxqRs_tLNs) about the subject.