From 231503f6ec0834553aa7a253354a59d76a4a320b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=8E=E5=A9=B7=E5=A9=B7?= Date: Fri, 12 Jun 2020 10:35:43 +0800 Subject: [PATCH] update the structure and add FAQ --- docs/src/SUMMARY.md | 2 -- docs/src/beacon-chain.md | 18 ------------------ docs/src/faq.md | 27 +++++++++++++++++++++++++++ docs/src/intro.md | 4 ++-- docs/src/nimbus.md | 6 ------ 5 files changed, 29 insertions(+), 28 deletions(-) delete mode 100644 docs/src/beacon-chain.md delete mode 100644 docs/src/nimbus.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 61e295400..c3557076a 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,8 +1,6 @@ # Summary - [Introduction](./intro.md) - - [What is Beacon Chain?](./beacon-chain.md) - - [What is Nimbus?](./nimbus.md) - [Become a Validator](./validator.md) - [Installation](./install.md) - [API](./api.md) diff --git a/docs/src/beacon-chain.md b/docs/src/beacon-chain.md deleted file mode 100644 index 0d7446889..000000000 --- a/docs/src/beacon-chain.md +++ /dev/null @@ -1,18 +0,0 @@ -# What is Beacon Chain? - -A complete introduction about the beacon chain can be found in the [Ethereum 2.0 blog series](https://our.status.im/two-point-oh-the-beacon-chain/). - -In short, the beacon chain is a **new type of blockchain** to help the Ethereum blockchain to smoothly transfer its consensus algorithm from PoW (Proof of Work) to PoS (Proof of Stake), aka Ethereum 2.0. You can also see it as a hybrid PoS + PoW solution. - -## Differences Compared to Ethereum 1.0 - -In traditional PoW, those that propose new blocks are called **_miners_**, whereas in PoS, they are called **_validators_**. In essence, _miners_ rely on actual hardware (such as some specifically manufactured mining machines), while _validators_ rely on just software. - -## What it is Like to Be a Validator? - -It is obvious that you must have enough computing power or dedicated hardware in order to be a miner, but how about being a validator? Here is a brief overview: - -1. A special smart contract named **_deposit contract_** is deployed on the original Ethereum blockchain. Note that in this case, the new beacon chain and the original blockchain co-exists. -2. To "register" as a validator, you have to first deposit **_32 Ether_** from your account to this smart contract. -3. Run the beacon node and wait for the network to sync before your validator is activated. -4. That's all! Remember to stay connected to the network, or you may lose your deposit. :P diff --git a/docs/src/faq.md b/docs/src/faq.md index 318b08dc2..e04ec9aac 100644 --- a/docs/src/faq.md +++ b/docs/src/faq.md @@ -1 +1,28 @@ # Frequently Asked Questions + +## 1. What is Beacon Chain? + +A complete introduction about the beacon chain can be found in the [Ethereum 2.0 blog series](https://our.status.im/two-point-oh-the-beacon-chain/). + +In short, the beacon chain is a **new type of blockchain** to help the Ethereum blockchain to smoothly transfer its consensus algorithm from PoW (Proof of Work) to PoS (Proof of Stake), aka Ethereum 2.0. You can also see it as a hybrid PoS + PoW solution. + +## 2. Differences Between Beacon Chain and Ethereum 1.0 + +In traditional PoW, those that propose new blocks are called **_miners_**, whereas in PoS, they are called **_validators_**. In essence, _miners_ rely on actual hardware (such as some specifically manufactured mining machines), while _validators_ rely on just software. + +## 3. What it is Like to Be a Validator? + +It is obvious that you must have enough computing power or dedicated hardware in order to be a miner, but how about being a validator? Here is a brief overview: + +1. A special smart contract named **_deposit contract_** is deployed on the original Ethereum blockchain. Note that in this case, the new beacon chain and the original blockchain co-exists. +2. To "register" as a validator, you have to first deposit **_32 Ether_** from your account to this smart contract. +3. Run the beacon node and wait for the network to sync before your validator is activated. +4. That's all! Remember to stay connected to the network, or you may lose your deposit. :P + +## 4. What is Nimbus? + +In a sentence, Nimbus is an Ethereum 1.0 & 2.0 Client for Resource-Restricted Devices. + +It is open sourced at [github.com/status-im/nimbus](github.com/status-im/nimbus). Development progress and updates can be viewed at the [Nimbus blog](https://our.status.im/tag/nimbus/). + +## 5. Why should you choose Nimbus? diff --git a/docs/src/intro.md b/docs/src/intro.md index 447934924..06975a323 100644 --- a/docs/src/intro.md +++ b/docs/src/intro.md @@ -11,8 +11,8 @@ Nimbus beacon chain is a research implementation of the beacon chain component o In this book, we will cover: -1. [What is beacon chain](./beacon-chain.md) and [what is Nimbus](./nimbus.md) to equip you with some basic knowledge. -2. How to [become a validator](./validator.md) in Ethereum as a user. +1. [What is beacon chain](./faq.md#1-what-is-beacon-chain) and [what is Nimbus](./faq.md#4-what-is-nimbus) to equip you with some basic knowledge. +2. How to [become a validator](./validator.md) in Ethereum 2.0 as a user. 3. [Installation steps](./install.md) for nimbus beacon chain. 4. The [api documentation](./api.md) for interested developers. 5. [Advanced usage](./advanced.md) for developers. diff --git a/docs/src/nimbus.md b/docs/src/nimbus.md deleted file mode 100644 index 59223fd76..000000000 --- a/docs/src/nimbus.md +++ /dev/null @@ -1,6 +0,0 @@ -# What is Nimbus? -In a sentence, Nimbus is an Ethereum 1.0 & 2.0 Client for Resource-Restricted Devices. - -It is open sourced at [github.com/status-im/nimbus](github.com/status-im/nimbus). Development progress and updates can be viewed at the [Nimbus blog](https://our.status.im/tag/nimbus/). - -## Why should you choose Nimbus?