Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ethereum/beacon-apis
Collection of RESTful APIs provided by Ethereum Beacon nodes
https://github.com/ethereum/beacon-apis
api eth2 openapi3 rest specification swagger
Last synced: 1 day ago
JSON representation
Collection of RESTful APIs provided by Ethereum Beacon nodes
- Host: GitHub
- URL: https://github.com/ethereum/beacon-apis
- Owner: ethereum
- License: cc0-1.0
- Created: 2019-08-15T21:27:12.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-12T22:48:36.000Z (10 days ago)
- Last Synced: 2024-12-18T00:44:27.261Z (5 days ago)
- Topics: api, eth2, openapi3, rest, specification, swagger
- Language: HTML
- Homepage: https://ethereum.github.io/beacon-APIs/
- Size: 12.5 MB
- Stars: 340
- Watchers: 37
- Forks: 174
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# Ethereum Beacon APIs
Collection of RESTful APIs provided by Ethereum Beacon nodes
API browser: [https://ethereum.github.io/beacon-APIs/](https://ethereum.github.io/beacon-APIs/)
## Outline
This document outlines an application programming interface (API) which is exposed by a beacon node implementation of the Ethereum [consensus layer specifications](https://github.com/ethereum/consensus-specs).
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.
## Render
To render spec in browser you will need any http server to load `index.html` file
in root of the repo.
##### Python
```
python -m http.server 8080
```
And api spec will render on [http://localhost:8080](http://localhost:8080).
##### NodeJs
```
npm install simplehttpserver -g
# OR
yarn global add simplehttpserver
simplehttpserver
```
And api spec will render on [http://localhost:8000](http://localhost:8000).
### Usage
Local changes will be observable if "dev" is selected in the "Select a definition" drop-down in the web UI.
Users may need to tick the "Disable Cache" box in their browser's developer tools to see changes after modifying the source.
## Contributing
Api spec is checked for lint errors before merge.
To run lint locally, install linter with
```
npm install -g @redocly/cli
# OR
yarn global add @redocly/cli
```
and run lint with
```
redocly lint beacon-node-oapi.yaml
```
## Releasing
This repository supports both stable and pre-releases. The version of the next release has to be
determined based on the changes in `master` branch since the last stable release. It is recommended
to create a pre-release before releasing a new stable version.
### Stable releases
Steps to create a new stable release:
- Create and push a tag with the version of the release, e.g. `v3.0.0`
- CD will create the github release, upload bundled spec files, and open a release PR
- Review, approve and merge the release PR to `master` branch
### Pre-releases
Steps to create a new pre-release:
- Create and push a tag with the version of the release, e.g. `v3.0.0-alpha.0`
- CD will create the github release and upload bundled spec files
Pre-releases will not be listed in `index.html` and are intended to allow early testing against the spec.