status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Book edits (#2887) 

* cp

* cp
This commit is contained in:
sacha 2021-09-22 15:52:42 +02:00 committed by GitHub
parent 9b41bb64da
commit 2ec34e6761
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/the_nimbus_book/src/intro.md
View File

@ -29,15 +29,6 @@ This book explains the ways in which you can use Nimbus to either monitor the et
- [Danny Ryan's annotated spec](https://notes.ethereum.org/@djrtwo/Bkn3zpwxB)
### Why eth2?
Eth2 is a multi-year plan to improve the scalability, security, and programmability of Ethereum, without compromising on decentralisation.
In contrast to the Ethereum chain, as it currently stands, eth2 uses proof-of-stake (PoS) to secure its network. And while Ethereum as you know and love it will continue to exist as its own independent proof-of-work chain for a little while to come, the transition towards PoS starts now.
> In traditional PoW, block proposers 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 software (such as Nimbus) and a good network connection.
### Get in touch
Need help with anything? Join us on [Status](https://join.status.im/nimbus-general) and [Discord](https://discord.gg/9dWwPnG).

20
docs/the_nimbus_book/src/rest-api.md
View File

@ -1,5 +1,21 @@
# REST API
Nimbus supports the [common REST API](https://ethereum.github.io/eth2.0-APIs/#/) for runtime communication with the application. For historical reasons, a [JSON-RPC-based API](./api.md) is also supported.
Nimbus supports the [common REST API](https://ethereum.github.io/beacon-APIs/) for runtime communication.
> The REST API is currently in BETA -- to enable it, use the `--rest` option when starting the beacon node, then access the API from http://localhost:5052/.
The API is a REST interface, accessed via HTTP. The API should not, unless protected by additional security layers, be exposed to the public Internet as the API includes multiple endpoints which could open your node to denial-of-service (DoS) attacks through endpoints triggering heavy processing. Currently, the only supported return data type is JSON.
The beacon node (BN) maintains the state of the beacon chain by communicating with other beacon nodes in the Ethereum network. Conceptually, it does not maintain keypairs that participate with the beacon chain.
The validator client (VC) is a conceptually separate entity which utilizes private keys to perform validator related tasks, called "duties", on the beacon chain. These duties include the production of beacon blocks and signing of attestations.
The goal of this specification is to promote interoperability between various beacon node implementations.
## Specification
The specification is documented [here](https://ethereum.github.io/beacon-APIs/#/Beacon/getGenesis).
See the Readme [here](https://github.com/ethereum/beacon-apis).
The REST API is currently in BETA -- to enable it, use the `--rest` option when starting the beacon node, then access the API from http://localhost:5052/.