Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Beacon Node API for Validator #1069

Merged
merged 19 commits into from
May 28, 2019
Merged

Beacon Node API for Validator #1069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
0d06f6b
Added the first draft of the BN-VC API RFC, as it was listed on the i…
spble May 8, 2019
4d2e752
Started updating the markdown description of the BNVC REST API, remov…
spble May 8, 2019
39fd625
Started porting the API proposal into OpenAPI 3 format.
spble May 9, 2019
b918cc3
Fleshed out a whole lot more of the OpenAPI specification for the API.
spble May 10, 2019
48ed25b
Fleshed out a lot more of the API, nearly ready.
spble May 13, 2019
d10baf1
Added optional path, , renamed tags, and fixed up whitespace issues.
spble May 13, 2019
2035aea
Formatting clean up.
spble May 13, 2019
0b2c7ac
Fixed up markdown.
spble May 13, 2019
ac7a403
Included a link to the API document in the root README.md file.
spble May 13, 2019
67921ab
Fixed up some small wording in the API readme.
spble May 13, 2019
73c9d12
Updated API spec with suggestions by @hwwhww.
spble May 20, 2019
490cf9e
Updated version number to reflect small changes.
spble May 20, 2019
8e67dec
Fixed misinterpretation of the proof array in the Deposit object, bum…
spble May 20, 2019
7b30c55
minor copy edits to vc api
djrtwo May 23, 2019
edf0b9d
Addressed some of @djrtwo's suggestions.
spble May 24, 2019
af798a3
Minor updates.
spble May 27, 2019
fa177e0
Bumped API version number to 0.2.0
spble May 27, 2019
5669860
Updated all absolute URLs to the eth2.0-specs repo so that they point…
spble May 28, 2019
c32328f
Fixed swagger URL so that the version number isn't specified (default…
spble May 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Core specifications for eth2.0 client validation can be found in [specs/core](sp
* [General test format](specs/test_formats/README.md)
* [Merkle proof formats](specs/light_client/merkle_proofs.md)
* [Light client syncing protocol](specs/light_client/sync_protocol.md)
* [Beacon node API for validator](specs/validator/0_beacon-node-validator-api.md)


### Design goals
Expand Down
28 changes: 28 additions & 0 deletions specs/validator/0_beacon-node-validator-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Ethereum 2.0 Phase 0 -- Beacon Node API for Validator

__NOTICE__: This document is a work-in-progress for researchers and implementers. This is an accompanying document to [Ethereum 2.0 Phase 0 -- Honest Validator](0_beacon-chain-validator.md) that describes an API exposed by the beacon node, which enables the validator client to participate in the Ethereum 2.0 protocol.

## Outline

This document outlines a minimal application programming interface (API) which is exposed by a beacon node for use by a validator client implementation which aims to facilitate [_phase 0_](../../README.md#phase-0) of Ethereum 2.0.

The API is a REST interface, accessed via HTTP, designed for use as a local communications protocol between binaries. The only supported return data type is currently JSON.

### Background
The beacon node maintains the state of the beacon chain by communicating with other beacon nodes in the Ethereum Serenity network. Conceptually, it does not maintain keypairs that participate with the beacon chain.

The validator client is a conceptually separate entity which utilizes private keys to perform validator related tasks on the beacon chain, which we call validator "duties". These duties include the production of beacon blocks and signing of attestations.

Since it is recommended to separate these concerns in the client implementations, we must clearly define the communication between them.

The goal of this specification is to promote interoperability between beacon nodes and validator clients derived from different projects and to encourage innovation in validator client implementations, independently from beacon node development. For example, the validator client from Lighthouse could communicate with a running instance of the beacon node from Prysm, or a staking pool might create a decentrally managed validator client which utilises the same API.

This specification is derived from a proposal and discussion on Issues [#1011](https://github.com/ethereum/eth2.0-specs/issues/1011) and [#1012](https://github.com/ethereum/eth2.0-specs/issues/1012)


## Specification

The API specification has been written in [OpenAPI 3.0](https://swagger.io/docs/specification/about/) and is provided in the [beacon_node_oapi.yaml](beacon_node_oapi.yaml) file alongside this document.

For convenience, this specification has been uploaded to [SwaggerHub](https://swagger.io/tools/swaggerhub/) at the following URL:
[https://app.swaggerhub.com/apis/spble/beacon_node_api_for_validator](https://app.swaggerhub.com/apis/spble/beacon_node_api_for_validator)
Loading