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.

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

Add Debug RPC Service to Prysm #5666

Merged
merged 6 commits into from
Apr 28, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
50 changes: 50 additions & 0 deletions proto/beacon/rpc/v1/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
load("@rules_proto//proto:defs.bzl", "proto_library")

# gazelle:ignore
load("@io_bazel_rules_go//go:def.bzl", "go_library")
load("@io_bazel_rules_go//proto:def.bzl", "go_proto_library")

go_proto_library(
name = "go_grpc_gateway_library",
compilers = [
"@io_bazel_rules_go//proto:go_grpc",
"@grpc_ecosystem_grpc_gateway//protoc-gen-grpc-gateway:go_gen_grpc_gateway",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you want to add this to the gRPC gateway? it's not automatic

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added in #5668

],
importpath = "github.com/prysmaticlabs/prysm/proto/beacon/rpc/v1_gateway",
proto = ":v1_proto",
visibility = ["//visibility:public"],
deps = [
"//proto/beacon/p2p/v1:go_default_library",
"@go_googleapis//google/api:annotations_go_proto",
"@com_github_golang_protobuf//descriptor:go_default_library",
],
)

go_proto_library(
name = "v1_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
importpath = "github.com/prysmaticlabs/prysm/proto/beacon/rpc/v1",
proto = ":v1_proto",
visibility = ["//visibility:public"],
deps = [
"//proto/beacon/p2p/v1:go_default_library",
"@go_googleapis//google/api:annotations_go_proto",
],
)

go_library(
name = "go_default_library",
embed = [":v1_go_proto"],
importpath = "github.com/prysmaticlabs/prysm/proto/beacon/rpc/v1",
visibility = ["//visibility:public"],
)

proto_library(
name = "v1_proto",
srcs = ["debug.proto"],
visibility = ["//visibility:public"],
deps = [
"//proto/beacon/p2p/v1:v1_proto",
"@go_googleapis//google/api:annotations_proto",
],
)
33 changes: 33 additions & 0 deletions proto/beacon/rpc/v1/debug.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
syntax = "proto3";

package ethereum.beacon.rpc.v1;

import "proto/beacon/p2p/v1/types.proto";
import "google/api/annotations.proto";

// Debug service API
//
// The debug service in Prysm provides API access to various utilities
// for debugging the beacon node's functionality at runtime, such as being able
// to retrieve the beacon state by block root or state root from the node directly.
service Debug {
// Returns a beacon state by filter criteria from the beacon node.
rpc GetBeaconState(BeaconStateRequest) returns (ethereum.beacon.p2p.v1.BeaconState) {
option (google.api.http) = {
get: "/eth/v1alpha1/beacon/state"
};
}
}

message BeaconStateRequest {
oneof query_filter {
// The slot corresponding to a desired beacon state.
uint64 slot = 1;

// The block root corresponding to a desired beacon state.
bytes block_root = 2;

// The state root corresponding to a desired beacon state.
bytes state_root = 3;
}
}