prysm-pulse/proto/eth/service/beacon_debug_service.proto

// Copyright 2020 Prysmatic Labs.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";

package ethereum.eth.service;

import "google/api/annotations.proto";
import "google/protobuf/descriptor.proto";
import "google/protobuf/empty.proto";

import "proto/eth/v1/beacon_chain.proto";
import "proto/eth/v1/beacon_state.proto";
import "proto/eth/v2/beacon_state.proto";

option csharp_namespace = "Ethereum.Eth.Service";
option go_package = "github.com/prysmaticlabs/prysm/proto/eth/service";
option java_multiple_files = true;
option java_outer_classname = "BeaconDebugServiceProto";
option java_package = "org.ethereum.eth.service";
option php_namespace = "Ethereum\\Eth\\Service";

// Beacon chain debug API
//
// The beacon chain debug API is a set of endpoints to debug chain and shouldn't be exposed publicly.
//
// This service is defined in the upstream Ethereum consensus APIs repository (beacon-apis/apis/debug).
service BeaconDebug {
  // GetBeaconState returns full BeaconState object for given stateId.
  rpc GetBeaconState(v1.StateRequest) returns (v1.BeaconStateResponse) {
    option (google.api.http) = {
      get: "/eth/v1/debug/beacon/states/{state_id}"
    };
  }

  // GetBeaconStateSSZ returns the SSZ-serialized version of the full BeaconState object for given stateId.
  rpc GetBeaconStateSSZ(v1.StateRequest) returns (v1.BeaconStateSSZResponse) {
    option (google.api.http) = {
      get: "/eth/v1/debug/beacon/states/{state_id}/ssz"
    };
  }

  // GetBeaconStateV2 returns full BeaconState object for given stateId.
  rpc GetBeaconStateV2(v2.StateRequestV2) returns (v2.BeaconStateResponseV2) {
    option (google.api.http) = {
      get: "/eth/v2/debug/beacon/states/{state_id}"
    };
  }

  // GetBeaconStateSSZV2 returns the SSZ-serialized version of the full BeaconState object for given stateId.
  rpc GetBeaconStateSSZV2(v2.StateRequestV2) returns (v2.BeaconStateSSZResponseV2) {
    option (google.api.http) = {
      get: "/eth/v2/debug/beacon/states/{state_id}/ssz"
    };
  }

  // ListForkChoiceHeads retrieves all possible chain heads (leaves of fork choice tree).
  rpc ListForkChoiceHeads(google.protobuf.Empty) returns (v1.ForkChoiceHeadsResponse) {
    option (google.api.http) = {
      get: "/eth/v1/debug/beacon/heads"
    };
  }
}