Fixed some more content
This commit is contained in:
parent
0fff4711d0
commit
dd586b3b24
|
@ -2,6 +2,7 @@ docs:
|
||||||
Nimbus:
|
Nimbus:
|
||||||
introduction: index.html
|
introduction: index.html
|
||||||
building: building.html
|
building: building.html
|
||||||
|
libs: libs.html
|
||||||
milestones: milestones.html
|
milestones: milestones.html
|
||||||
design: design.html
|
design: design.html
|
||||||
team: team.html
|
team: team.html
|
||||||
|
|
|
@ -4,4 +4,23 @@ title: Contributor Guide
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
# How To Get Involved In Research At Status
|
# How To Get Involved with Nimbus' development
|
||||||
|
|
||||||
|
- look around [the repo](https://github.com/status-im/nimbus), especially the [open issues](https://github.com/status-im/nimbus/issues)
|
||||||
|
- check out some [open bounties](https://openbounty.status.im/app#/)
|
||||||
|
- check out some [more open bounties](https://gitcoin.co/explorer?keywords=nimbus&order_by=-web3_created)
|
||||||
|
- learn about the source code by [dissecting](https://github.com/status-im/nimbus/tree/master/tests) and [debugging](https://github.com/status-im/nimbus/wiki/Understanding-and-debugging-Nimbus-EVM-JSON-tests) the tests
|
||||||
|
|
||||||
|
## Thought Experiments
|
||||||
|
|
||||||
|
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 that you think might be bite too big for Geth or Parity to chew, let us know. We'll gladly experiment!
|
||||||
|
|
||||||
|
## Guidelines
|
||||||
|
|
||||||
|
Whatever you might expect to see in other projects applies here:
|
||||||
|
|
||||||
|
- be nice to others
|
||||||
|
- when evaluating PRs, focus exclusively on the quality of the code
|
||||||
|
- if submitting code, make sure it's tested. All code MUST come with tests. To speed up the review, ping a [team member](/docs/team).
|
||||||
|
- if submitting typo fixes or documentation changes, speed up the review process by pinging a team member. [Swader](https://github.com/swader) will usually review those very quickly.
|
||||||
|
- if submitting a tutorial for inclusion on the [official blog](), also feel free to ping [Swader](https://github.com/swader).
|
|
@ -42,4 +42,4 @@ Within the community at large, we will promote Ethereum as the leader of scalabl
|
||||||
|
|
||||||
## Bounty-Based Development
|
## Bounty-Based Development
|
||||||
|
|
||||||
To entice the community to accelerate the development, we will attach bounties to and **[publish](https://openbounty.status.im/app#/) **the tasks that can be self-contained and defined clearly.
|
To entice the community to accelerate the development, we will attach bounties to and **[publish](https://openbounty.status.im/app#/)** the tasks that can be self-contained and defined clearly.
|
||||||
|
|
|
@ -1,31 +1,14 @@
|
||||||
title: An Ethereum 2.0 Sharding Client
|
title: An Ethereum 2.0 Sharding Client
|
||||||
---
|
---
|
||||||
|
|
||||||
## OVERVIEW
|
## Overview
|
||||||
|
|
||||||
Draft 2018-05-22
|
|
||||||
|
|
||||||
Nimbus aims to be a [sharding](https://github.com/ethereum/wiki/wiki/Sharding-FAQ) client implementation for the Ethereum Blockchain Application Platform. Because the largest deployment of Ethereum will potentially be on embedded systems, Nimbus will be designed to perform well on IoT and personal mobile devices, including older smartphones with resource-restricted hardware. The extensible, configurable, and modular design of Nimbus will make it production ready for Web 3.0 and will ensure that it can be supported and maintained across all goals of Ethereum 2.0.
|
Nimbus aims to be a [sharding](https://github.com/ethereum/wiki/wiki/Sharding-FAQ) client implementation for the Ethereum Blockchain Application Platform. Because the largest deployment of Ethereum will potentially be on embedded systems, Nimbus will be designed to perform well on IoT and personal mobile devices, including older smartphones with resource-restricted hardware. The extensible, configurable, and modular design of Nimbus will make it production ready for Web 3.0 and will ensure 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 post or proceed directly to [getting started](/docs/building.html) if you're already sold.
|
||||||
## GOALS
|
|
||||||
|
|
||||||
|
|
||||||
1. Create an Ethereum implementation suitable for resource-restricted devices.
|
## Requirements
|
||||||
1. Create an implementation team for the [Applied Research Objectives](https://hackmd.io/s/HkLkj55yb#objectives-in-applied-research) of [Ethereum Research](http://ethereumresearch.org/) (aka Ethereum Asia Pacific Limited), with focus on the following:
|
|
||||||
1. Proof of Stake (PoS)
|
|
||||||
1. Sharding
|
|
||||||
1. Stateless Clients
|
|
||||||
1. LES2
|
|
||||||
1. eWASM
|
|
||||||
1. Close the gap between research modeling and production.
|
|
||||||
1. Pledge to participate in, help implement, and conform to the [Ethereum Improvement Proposal](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md).
|
|
||||||
1. Implement permissive licensing.
|
|
||||||
1. Focus on production-ready [Web 3.0](https://medium.com/@matteozago/why-the-web-3-0-matters-and-you-should-know-about-it-a5851d63c949) Stack ([Whisper](https://github.com/ethereum/wiki/wiki/Whisper), [PSS](https://github.com/nolash/psstalk/blob/master/README.md), and [Swarm](https://swarm-guide.readthedocs.io/en/latest/introduction.html)) and its ongoing research and development.
|
|
||||||
1. Focus on marketing and promotion to address community concerns on scalability and to bolster Ethereum's dominant mindshare.
|
|
||||||
|
|
||||||
|
|
||||||
## REQUIREMENTS
|
|
||||||
|
|
||||||
[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 to 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 will allow us to implement Ethereum rapidly and to take advantage of the mature C-language tooling: in compilation of machine code, and in the analysis of static code.
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,54 @@
|
||||||
|
title: An Ethereum 2.0 Sharding Client
|
||||||
|
---
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Nimbus aims to be a [sharding](https://github.com/ethereum/wiki/wiki/Sharding-FAQ) client implementation for the Ethereum Blockchain Application Platform. Because the largest deployment of Ethereum will potentially be on embedded systems, Nimbus will be designed to perform well on IoT and personal mobile devices, including older smartphones with resource-restricted hardware. The extensible, configurable, and modular design of Nimbus will make it production ready for Web 3.0 and will ensure that it can be supported and maintained across all goals of Ethereum 2.0.
|
||||||
|
|
||||||
|
|
||||||
|
## GOALS
|
||||||
|
|
||||||
|
|
||||||
|
1. Create an Ethereum implementation suitable for resource-restricted devices.
|
||||||
|
1. Create an implementation team for the [Applied Research Objectives](https://hackmd.io/s/HkLkj55yb#objectives-in-applied-research) of [Ethereum Research](http://ethereumresearch.org/) (aka Ethereum Asia Pacific Limited), with focus on the following:
|
||||||
|
1. Proof of Stake (PoS)
|
||||||
|
1. Sharding
|
||||||
|
1. Stateless Clients
|
||||||
|
1. LES2
|
||||||
|
1. eWASM
|
||||||
|
1. Close the gap between research modeling and production.
|
||||||
|
1. Pledge to participate in, help implement, and conform to the [Ethereum Improvement Proposal](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1.md).
|
||||||
|
1. Implement permissive licensing.
|
||||||
|
1. Focus on production-ready [Web 3.0](https://medium.com/@matteozago/why-the-web-3-0-matters-and-you-should-know-about-it-a5851d63c949) Stack ([Whisper](https://github.com/ethereum/wiki/wiki/Whisper), [PSS](https://github.com/nolash/psstalk/blob/master/README.md), and [Swarm](https://swarm-guide.readthedocs.io/en/latest/introduction.html)) and its ongoing research and development.
|
||||||
|
1. Focus on marketing and promotion to address community concerns on scalability and to bolster Ethereum's dominant mindshare.
|
||||||
|
|
||||||
|
|
||||||
|
## REQUIREMENTS
|
||||||
|
|
||||||
|
[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 to 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:
|
||||||
|
|
||||||
|
1. Enables us to easily bring research into production
|
||||||
|
1. Has a high degree of reasonability for researchers
|
||||||
|
1. Is performant in production
|
||||||
|
|
||||||
|
The core contributors and Nim community have been very supportive and enthusiastic for the project.
|
||||||
|
|
||||||
|
|
||||||
|
## 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 archival nodes, its first 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 onto embedded systems has been an afterthought.
|
||||||
|
|
||||||
|
In addition, throughout the development of Status, we have found that the dominant Ethereum implementations, Geth and Parity, are unsuitable for our target platform unless they are profiled and optimised (in progress).
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
|
||||||
|
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://en.wikipedia.org/wiki/RISC-V)
|
||||||
|
|
||||||
|
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.
|
|
@ -0,0 +1,5 @@
|
||||||
|
---
|
||||||
|
id: libs
|
||||||
|
title: Software Libraries
|
||||||
|
---
|
||||||
|
|
|
@ -24,6 +24,7 @@ sidebar:
|
||||||
milestones: Milestones
|
milestones: Milestones
|
||||||
design: Design
|
design: Design
|
||||||
faq : FAQ
|
faq : FAQ
|
||||||
|
libs: Software Libraries
|
||||||
building: Getting Started
|
building: Getting Started
|
||||||
resources: Resources
|
resources: Resources
|
||||||
team: Team
|
team: Team
|
||||||
|
|
|
@ -5,7 +5,7 @@
|
||||||
<p>Researching and implementing lighter Ethereum 2.0 clients </p>
|
<p>Researching and implementing lighter Ethereum 2.0 clients </p>
|
||||||
<div class="intro-buttons">
|
<div class="intro-buttons">
|
||||||
<a class="button button--main" href="https://gitter.im/status-im/nimbus">JOIN OUR GITTER</a>
|
<a class="button button--main" href="https://gitter.im/status-im/nimbus">JOIN OUR GITTER</a>
|
||||||
<a class="button button--secondary" href="/docs/">GET INVOLVED</a>
|
<a class="button button--main" href="/docs/">GET INVOLVED</a>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
@ -14,7 +14,7 @@
|
||||||
<h2 id="top-header">Future Plans</h2>
|
<h2 id="top-header">Future Plans</h2>
|
||||||
<p>Nimbus is a research project and a client implementation for Ethereum 2.0 designed to perform well on embedded systems and personal mobile devices, including older smartphones with resource-restricted hardware.
|
<p>Nimbus is a research project and a client implementation for Ethereum 2.0 designed to perform well on embedded systems and personal mobile devices, including older smartphones with resource-restricted hardware.
|
||||||
</p>
|
</p>
|
||||||
<a href="https://github.com/status-im/nimbus">Learn More on Github <img src="../img/arrow_orange.svg" /></a>
|
<a href="/docs/milestones.html">Our milestones <img src="../img/arrow_orange.svg" /></a>
|
||||||
<div class="work-items">
|
<div class="work-items">
|
||||||
<div class="work-item">
|
<div class="work-item">
|
||||||
<div class="work-item-inner">
|
<div class="work-item-inner">
|
||||||
|
@ -22,7 +22,7 @@
|
||||||
<p>We’re translating the latest Ethereum 2.0 research like BN curves, BLS signatures and RANDAO games into practical, performant and reusable
|
<p>We’re translating the latest Ethereum 2.0 research like BN curves, BLS signatures and RANDAO games into practical, performant and reusable
|
||||||
libraries to provide fertile exploration ground for further R&D. Want to run advanced simulations and tests? Get in touch!
|
libraries to provide fertile exploration ground for further R&D. Want to run advanced simulations and tests? Get in touch!
|
||||||
</p>
|
</p>
|
||||||
<a href="https://github.com/status-im/nimbus">See docs <img src="../img/arrow_orange.svg" /></a>
|
<a href="/docs">See docs <img src="../img/arrow_orange.svg" /></a>
|
||||||
</div>
|
</div>
|
||||||
<img class="work-item-image" src="../img/graphic-research.svg" />
|
<img class="work-item-image" src="../img/graphic-research.svg" />
|
||||||
</div>
|
</div>
|
||||||
|
@ -38,8 +38,7 @@
|
||||||
<div class="work-item">
|
<div class="work-item">
|
||||||
<div class="work-item-inner">
|
<div class="work-item-inner">
|
||||||
<h2>Friendly Networking</h2>
|
<h2>Friendly Networking</h2>
|
||||||
<p>We’re translating the latest Ethereum 2.0 research like BN curves, BLS signatures and RANDAO games into practical,
|
<p>We're crazy about hacking together. Want to make Nimbus or Nim the focus of your hackathon? Coming to one of ours but not sure where to start? We'd love to help you out and get the ball rolling. Get in touch!
|
||||||
performant and reusable libraries to provide fertile exploration ground for further R&D. Want to run advanced simulations and tests? Get in touch!
|
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
<img class="work-item-image" src="../img/graphic-network.svg" />
|
<img class="work-item-image" src="../img/graphic-network.svg" />
|
||||||
|
@ -79,8 +78,8 @@
|
||||||
<h3>Join the Conversation</h3>
|
<h3>Join the Conversation</h3>
|
||||||
<p>We are an open community and happy to answer your questions and help you learn more about Nimbus.
|
<p>We are an open community and happy to answer your questions and help you learn more about Nimbus.
|
||||||
<p>
|
<p>
|
||||||
<a href="https://get.status.im/chat/public/nimbus">Join us in Status</a>
|
<a href="https://get.status.im/chat/public/status-nimbus">Join us in Status</a>
|
||||||
<span><a href="https://get.status.im/chat/public/nimbus"><img src="../img/arrow_ogn.png" /></a></span>
|
<span><a href="https://get.status.im/chat/public/status-nimbus"><img src="../img/arrow_ogn.png" /></a></span>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="inner-header">
|
<div class="inner-header">
|
||||||
|
@ -151,20 +150,21 @@
|
||||||
</div>
|
</div>
|
||||||
<div class="contribute-wrap">
|
<div class="contribute-wrap">
|
||||||
<div class="contribute blog">
|
<div class="contribute blog">
|
||||||
<h3></h3>
|
<h3>Nimbus for Newbies</h3>
|
||||||
<p></p>
|
<p>In this followup to the announcement post, we look at what Nimbus actually is right now and how to build it.</p>
|
||||||
<a href="#">Read More <img src="../img/arrow_ogn.png" /></a>
|
<a href="https://our.status.im/nimbus-for-newbies/">Read More <img src="../img/arrow_ogn.png" /></a>
|
||||||
</div>
|
</div>
|
||||||
|
<div class="contribute blog">
|
||||||
|
<h3>Status Partners with the Team Behind the Programming Language Nim</h3>
|
||||||
|
<p>We want the best of the best to build the new Ethereum client. It only makes sense to go to the "source" to get them.</p>
|
||||||
|
<a href="https://blog.status.im/status-partners-with-the-team-behind-the-programming-language-nim-d438207486fa">Read More <img src="../img/arrow_ogn.png" /></a>
|
||||||
|
</div>
|
||||||
<div class="contribute blog">
|
<div class="contribute blog">
|
||||||
<h3></h3>
|
<h3>Introducing Nimbus</h3>
|
||||||
<p></p>
|
<p>The original announcement post - the official birth of the Nimbus project</p>
|
||||||
<a href="#">Read More <img src="../img/arrow_ogn.png" /></a>
|
<a href="https://blog.status.im/introducing-nimbus-3360367bb311">Read More <img src="../img/arrow_ogn.png" /></a>
|
||||||
</div>
|
|
||||||
<div class="contribute blog">
|
|
||||||
<h3></h3>
|
|
||||||
<p></p>
|
|
||||||
<a href="#">Read More <img src="../img/arrow_ogn.png" /></a>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
|
@ -13,7 +13,6 @@
|
||||||
<div class="sub-menu">
|
<div class="sub-menu">
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="https://status.im">About</a></li>
|
<li><a href="https://status.im">About</a></li>
|
||||||
<li><a href="https://status.im">Features</a></li>
|
|
||||||
<li><a href="https://desktop.status.im">Desktop</a></li>
|
<li><a href="https://desktop.status.im">Desktop</a></li>
|
||||||
<li><a href="https://docs.status.im">Docs</a></li>
|
<li><a href="https://docs.status.im">Docs</a></li>
|
||||||
<li><a href="https://our.status.im">Blog</a></li>
|
<li><a href="https://our.status.im">Blog</a></li>
|
||||||
|
@ -37,9 +36,7 @@
|
||||||
<i class="mobile-submenu-trigger"></i>
|
<i class="mobile-submenu-trigger"></i>
|
||||||
<div class="sub-menu">
|
<div class="sub-menu">
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="https://status.im/incubate">About</a></li>
|
|
||||||
<li><a href="https://status.im/incubate">Projects</a></li>
|
<li><a href="https://status.im/incubate">Projects</a></li>
|
||||||
<li><a href="https://status.im/incubate">Submissions</a></li>
|
|
||||||
<li><a href="https://get.status.im/chat/public/status-incubate">Community</a></li>
|
<li><a href="https://get.status.im/chat/public/status-incubate">Community</a></li>
|
||||||
<li><a href="https://our.status.im/tag/incubate">Blog</a></li>
|
<li><a href="https://our.status.im/tag/incubate">Blog</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
|
@ -50,14 +47,14 @@
|
||||||
<i class="mobile-submenu-trigger"></i>
|
<i class="mobile-submenu-trigger"></i>
|
||||||
<div class="sub-menu">
|
<div class="sub-menu">
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="#">About</a></li>
|
<li><a href="/">About</a></li>
|
||||||
<li><a href="https://nimbus.status.im/docs/">Docs</a></li>
|
<li><a href="/docs/">Docs</a></li>
|
||||||
<li><a href="https://our.status.im/tag/research">Blog</a></li>
|
<li><a href="https://our.status.im/tag/research">Blog</a></li>
|
||||||
<li><a href="https://gitter.im/status-im/nimbus">Talk To Us</a></li>
|
<li><a href="http://get.status.im/chat/public/status-nimbus">Talk To Us</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
</li>
|
</li>
|
||||||
<li><a href="https://our.status.im/tag/hardwallet">Hardwallet</a></li>
|
<li><a href="https://hardwallet.status.im/">Hardwallet</a></li>
|
||||||
<li class="has-submenu">
|
<li class="has-submenu">
|
||||||
<a href="https://people-ops.status.im">Peopleops</a>
|
<a href="https://people-ops.status.im">Peopleops</a>
|
||||||
<i class="mobile-submenu-trigger"></i>
|
<i class="mobile-submenu-trigger"></i>
|
||||||
|
@ -83,7 +80,7 @@
|
||||||
</div>
|
</div>
|
||||||
<input type="search" id="search-input" placeholder="Search...">
|
<input type="search" id="search-input" placeholder="Search...">
|
||||||
</div>
|
</div>
|
||||||
<span><a href="http://get.status.im/chat/public/status-nimbus" class="button button--secondary">Status Public Chat</a></span>
|
<span><a href="http://get.status.im/chat/public/status-nimbus" class="button button--secondary">Nimbus Status Chat</a></span>
|
||||||
<span class="social-link social-link--twitter"><a href="https://twitter.com/ethstatus" target="_blank"></a></span>
|
<span class="social-link social-link--twitter"><a href="https://twitter.com/ethstatus" target="_blank"></a></span>
|
||||||
<span class="social-link social-link--github"><a href="https://github.com/status-im" target="_blank"></a></span>
|
<span class="social-link social-link--github"><a href="https://github.com/status-im" target="_blank"></a></span>
|
||||||
</div>
|
</div>
|
||||||
|
|
Loading…
Reference in New Issue