Skip to content

Update protobuf docs links / fix logo grpc-logo2.png #1069

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update protobuf docs links / fix logo grpc-logo2.png #1069

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions docs/how-prysm-works/prysm-public-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ For a standard API that all Ethereum beacon nodes implement, see [here](/how-pry

One of the required components of nodes in the Ethereum beacon chain network is to expose an API server for outside interaction. This API is critical for running validators on Ethereum, as validator clients can connect to nodes and query their API to figure out their assigned duties, to submit block proposals, and more. Prysm's Ethereum consensus API schema is maintained in Prysm itself here: [github.com/OffchainLabs/prysm/proto](https://github.com/OffchainLabs/prysm/tree/develop/proto) and is implemented by Prysm beacon nodes and validators.

![gRPC](/images/grpc-logo2.png)
![gRPC](https://github.com/OffchainLabs/prysm-documentation/blob/master/static/images/grpc-logo2.png)

Prysm implements its API by using the popular [gRPC](https://grpc.io) project created by Google, providing highly advanced functionality for Ethereum consensus. Interacting with the API requires the use of protocol buffers, also known as protobuf. These [protocol buffer](https://developers.google.com/protocol-buffers/). For information on the functionality of gRPC and protocol buffers more generally, see the [gRPC guide](https://grpc.io/guides/).

Expand All @@ -41,7 +41,7 @@ Some Prysm specific endpoints are still supported via REST under the prysm/v1 na

* [Awesome gRPC](https://github.com/grpc-ecosystem/awesome-grpc)
* [Google's API Style Guide](https://cloud.google.com/apis/design/)
* [Language reference for proto 3](https://developers.google.com/protocol-buffers/proto3)
* [Protocol Buffer Basics: Go](https://developers.google.com/protocol-buffers/gotutorial)
* [Language reference for proto 3](https://protobuf.dev/programming-guides/proto3)
* [Protocol Buffer Basics: Go](https://protobuf.dev/getting-started/gotutorial)
* [Transcoding gRPC to JSON/HTTP using Envoy](https://blog.jdriven.com/2018/11/transcoding-grpc-to-http-json-using-envoy/)
* [gRPCurl](https://github.com/fullstorydev/grpcurl)